1502756 - Consider adding JSDoc documentation for JavaScript files

Status: RESOLVED DUPLICATE of bug 1389341

(Firefox :: General, enhancement)

Description

[arika.arnzen]

Attachment: addedDocumentation.patch

User Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.77 Safari/537.36

Steps to reproduce:

JSDoc provides a documentation generator, creating documentation from a particular format of comments. More about JSDoc can be found here: http://usejsdoc.org/about-getting-started.html.

I think it would be helpful if this kind of automated documentation can be included in Mozilla to help the onboarding process of understanding the large code base. I included an example file of the simplicity of using JSDoc formatting. Commenting is a simple way to ensure that anyone reading code knows exactly what is expected from functions.

Comment 1

[Damira Akh]

Enhancement 
Placing this ticket under Core:DOM , please feel free to change if it's not in right place. 
Thank you

Comment 2

[Mike Conley (:mconley) (:⚙️)]

There is the Sphinx-JS project to try to do this very thing.

Hey erikrose, is there a tracking bug for Sphinx-JS documentation efforts that I can dupe this off to?

Comment 3

[Erik Rose [:erik][:erikrose]]

Happily, we now support JSDoc-style comments! They just haven't spread through the whole codebase yet. Please refer to bug 1389341 for the registries to twiddle if you want to polish the documentation syntax on more files. Cheers!