Keith Devens .com - Weblog: Programming language documentation standards

Monday, August 4, 2003

Programming language documentation standards

Now that all my test cases pass for every language, I have the task of documenting So, I'm now researching what's standard documentation practice for each of the languages I wrote an implementation of my secret project in.

First, Java:

Perl:

PHP:

phpDocumentor
What else is there for PHP? Is there anything more standard?

Python:

Docutils
Docstring conventions
Python Style Guide (original flavor) and the Python Style Guide (PEP flavor)
HTMLgen

C++:

Yeah, I have no clue what documentation standards I should use. I can use Javadoc-style comments, for instance, but is there anything that can process that and produce HTML documentation for it?

Update: Newest info here.

Permalink | 4 Comments | Tags: Programming | id 4155

11:47 (utc-4)
edited: 2003-08-09 12:00 (utc-4)

Comments

∴ Adam Vandenberg | 4-Aug-2003 11:59pm est | http://flangy.com | #2638

Awesome, thanks.

∴ Keith Gaughan | 6-Aug-2003 5:59am est | http://www.talideon.com/ | #2649

Awesome. I'm pretty sure I've heard of Doxygen before. That'll teach me to not not keep track of things I may one day find useful. I wonder what else is out there I didn't know about.

Feel free to post a comment below. Please see my comment policy.

Formatting Rules (No HTML):

**bold**, *italic*, _underlined_, --strikeout--
"text"="url" creates a link, and URLs are auto-highlighted
Blockquote: Like e-mail, begin paragraph with > (greater-than sign)
Lists: begin paragraph with *,-, or + (unordered), or # (ordered)
Code block: ?!code:language=perl|php|sql|javascript|etc.{\n}...{\n}?!/code

RSS feed RSS feed for Keith's Weblog
Atom feed Atom feed for Keith's Weblog
Weblog archive
Recent comments
on 7 posts