Hallo,
wie sinnvoll ist es mit JSDoc den Sourcecode zu dokumentieren?
IMO überhaupt nicht. Denn Dokumentation bedeutet für mich, den Sinn bestimmter Funktionen oder Code-Abschnitte zu beschreiben, sowie das Zusammenspiel der einzelnen Komponenten. Die sogenannten Dokuemntations-Systeme wie etwa JSDoc können aber bestenfalls auf Funktions- oder Objektebene die Schnittstellen beschreiben. Das ist meines Erachtens ein Teil der Dokumentation, aber nur ein sehr kleiner.
So long,
Martin
--
Nothing travels faster than the speed of light with the possible exception of bad news, which obeys its own special laws.
- Douglas Adams, The Hitchhiker's Guide To The Galaxy
Nothing travels faster than the speed of light with the possible exception of bad news, which obeys its own special laws.
- Douglas Adams, The Hitchhiker's Guide To The Galaxy