Comments & Documentation (was Re: semantics of init)
Comments & Documentation (was Re: semantics of init)
- Subject: Comments & Documentation (was Re: semantics of init)
- From: Wade Tregaskis <email@hidden>
- Date: Fri, 6 Jun 2003 09:58:17 +1000
Of course! I don't think anyone said "thou shalt always use accessors
everywhere". However, these situations are probably much less
frequent than you would expect (just like eXtremos like to point out
that comments are needed far less than most people think...)
This is probably especially true in Objective-C, where most of your
method names are suitably descriptive. In fact, I find the only
comments I ever put in my ObjC code are flags to indicate something's
broken or not implemented.
Does anyone else use comments in their ObjC code? I've been poking at
AutoDoc recently, and it seems to derive most (all?) it's results from
comments within the code. That's annoying for me, because I like my
code to be free of huge descriptive comment blocks, so I can actually
see what I'm doing when I'm working on it.
While I'm on the documentation side, what alternatives are there to
AutoDoc for generating HTML documentation? I like the Apple style, if
only because it's the 'standard', but the idea of having to fully edit
the AutoDoc-generated files kinda mutes most of the point of using
AutoDoc in the first place.
Wade Tregaskis
-- Sed quis custodiet ipsos custodes?
_______________________________________________
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.