search

cfpb / development

A repository for the discussion and publication of the CFPB development team standards.
Creative Commons Zero v1.0 Universal
63 stars 32 forks source link

JS documentation generators #74

Open contolini opened 9 years ago

contolini commented 9 years ago

We recommend using the JSDoc format for commenting code but we don't mention generating a documentation website from those comments.

JSDoc has a command-line tool that can do it automatically. There's also Docco which is used by hmda-explorer and eRegs used to use it (but stopped?). Does anyone have experience with other documentation generators?

I'm tempted to recommend the JSDoc generator buuuut the website it generates is ugly. We could create a custom template if anyone has the time/inclination.

Thoughts/opinions/anecdotes?

ascott1 commented 9 years ago

I like Docco, but I really like the idea of a custom JSDoc template. It also seems like that wouldn't be too hard to take on using existing styles we have (like DOCter or the generated CF css).

Maybe we recommend using JSDoc with an eye towards creating a custom template down the road?

anselmbradford commented 8 years ago

Been meaning to check this out.. http://documentation.js.org/

anselmbradford commented 3 years ago

Doc site (unhosted) is generated with gulp docs in https://github.com/cfpb/consumerfinance.gov and is generated at docs/scripts/index.html