If there isn’t a documentation standard, I can see three possible options that I’d like to suggest:
- Use XHTML.
- Use POD.
- Use JavaDoc
But a quick Googling yields JSDoc as a possible solution. The only downside to the JavaDoc/JSDoc solution is that it tends to allow authors to be too lazy. Since the application automatically documents the existence of functions and their signatures, often little else is documented. But that’s mainly a personal issue; I don’t have to be so lazy in my own documentation! I think I’ll give that a shot.
Meanwhile, if anyone knows of something better/more widely used, let me know!
"Learn about JSDoc (written in Perl!) on the project home page"
Looking for the comments? Try the old layout.