A
A
alex4answ2020-08-29 13:54:39
Documentation
alex4answ, 2020-08-29 13:54:39

Why is js code poorly documented?

Good afternoon, I work with node (express, etc.).

All projects that I met (REST API) are documented in a separate swagger.json file (the js / ts code itself does not contain documentation), why is jsDoc almost not used for automatic generation?

I also opened the sources of various libraries, all in TypeScript, but I did not see any specific code documentation.
I came to the world of JS from PHP, and almost every step, every variable, method, class is documented there.

Answer the question

In order to leave comments, you need to log in

1 answer(s)
X
xmoonlight, 2020-08-29
@alex4answ

Only complex sections of code, complex processing/calculation logic, special methods in classes, and implicit (by code) event subscriptions are documented.
Open the code of the game "engine" in js or encrypt / hash libraries in js, and you will immediately see code commenting in difficult (to understand) places.

Didn't find what you were looking for?

Ask your question

Ask a Question

731 491 924 answers to any question