What I wanted for Fathom’s manual was the ability to organize it logically, intersperse explanatory prose with extracted docs, and add entire sections which are nothing but conceptual overview and yet link into the rest of the work. While you can get away with this for tiny libraries, it fails badly for large ones like Fathom, which has complex new concepts to explain.
JSDoc scrambles up and flattens out your functions, leaving new users to infer their relationships and mentally sort them into comprehensible groups. Tooling like the Closure Compiler which hooks into those tagsīut the output is always a mere alphabetical list of everything in your project.A well-defined set of tags for describing common structures.JSDoc, long the sole contender, has some nice properties: Until now, there has been no good tool for documenting large JavaScript projects.
0 kommentar(er)
