Re: HeaderDoc vs AutoDoc
Re: HeaderDoc vs AutoDoc
- Subject: Re: HeaderDoc vs AutoDoc
- From: Jeff LaMarche <email@hidden>
- Date: Fri, 24 May 2002 11:20:35 -0700 (PDT)
On Friday, May 24, 2002, at 03:38PM, Bertrand Mansion <email@hidden> wrote:
>
I would like some help for choosing between AutoDoc and HeaderDoc for source
>
documentation. I know a bit about AutoDoc and I find the resulting html
Bertrand:
I have not used AutoDoc, so I can't really give you much insight on the comparison of the two. I have downloaded AutoDoc, but never got around to actually trying to use it.
I have been using HeaderDoc for my most recent project and despite its limitations, I actually like it and it similar enough to JavaDoc to make it a pretty easy cross-over. A couple of things that I like that may not apply to AutoDoc (but I can't say for certain)
1) Project Builder recognizes HeaderDoc comments and highlights them in a different color from other comments, which makes the code easier to read IMHO. It also makes me believe that this is the Tool that Apple is using internally, but I'd guess that they either just use it as a starting point, or they have some customizations that they are keeping in house. Doubt we'll get the official line, though...
2) Documentation is kept completely in the header, which is especially nice if you are writing a framework for distribution (which I am at the moment).
Some things I don't care for in HeaderDoc (none of which bother me all too much, but are worth mentioning):
1)Though I generally like that the doc is contained entirely in the comments,there are some times in the implementation file where I would like to be able to comment something and have it added as an annotation to the doc.
2) As far as I know, you can't document iVars. Usually documenting accessor and settor functions is sufficient, but an @variable or some such is certainly a nice-to-have.
3) It's PERL... would also be nice if it were just incorporated into PB
And, in both cases, the price is certainly right =)
_______________________________________________
cocoa-dev mailing list | email@hidden
Help/Unsubscribe/Archives:
http://www.lists.apple.com/mailman/listinfo/cocoa-dev
Do not post admin requests to the list. They will be ignored.