Friday, December 9, 2005

XCode and documentation

A couple of days ago, I was writing some java code.  I wanted to be a "good" developer, and document my code.  I decided to use javadoc format comments, as this is the standard for java code.

Since I was doing this on my Mac, I decided to use Xcode to do the development.  Once I got the code written and compiling, I figured I could add a new target to the project that would create the javadoc.

I found out that you can not create a target in Xcode that will produce javadocs.  Also I found that Apple doesn't recommend using javadoc format comments.  They actually have their own format of document, HeaderDoc.  This seems pretty bad to create their own format, that developers on other platforms will not support.

Technorati Tags: , ,