Documentation

Jump to bottom

laureleya edited this page Jun 3, 2020 · 2 revisions

Documentation.js

Pros:

easy to generate
pretty html page with documentation or inserted in readme markdown or other markdown document
open source under ISC license
community owned
very recent additions

Cons:

many open issues
if there is a bug, we'll probably have to fix it by ourselves.

###BUT Before putting our faith in one of the above, we all have to write more comments in our code -> see for example: https://make.wordpress.org/core/handbook/best-practices/inline-documentation-standards/javascript/