Re: General development tips
Re: General development tips
- Subject: Re: General development tips
- From: Matt Ronge <email@hidden>
- Date: Mon, 6 Nov 2006 10:44:26 -0600
On Nov 5, 2006, at 4:25 PM, David Aames wrote:
Hello all,
I'd like to ask everyone who has experience with this. There is a
point in time when the app source just becomes too big to manage
everything in your head - all the important stuff and who the API
is supposed to work and all these little TODOs and BUGs. I'm pretty
much a single developer working on a project so I don't any servers
which are just dedicated for myself to use. Currently I'm using
subversion for my SCM tool and nothing else in terms of management
tools. But my APIs are getting more in number & more complex with
every single day so what are you guys using to help you with the
development? Any bug management software (bugzilla, no?), source
documenting systems (I haven't found any good Obj-C ones), etc.
Thanks for sharing.
I highly recommend Doxygen, I've found it works great with Objective-
C. I place comments in my code like so:
/*!
@abstract This will return the message from this folder with the UID
that
was passed in. If the message can't be found, nil is returned
@param uid The uid as an NSString for the message to retrieve.
@result A CTMessage object is returned which can be used to get
further
information and perform operations on the message.
*/
- (CTCoreMessage *)messageWithUID:(NSString *)uid;
I've integrated it into the build system for my project, so that
every time I build, it updates the docs.
The result: http://www.theronge.com/MailCore/API/
interfaceCTCoreFolder.html
Note: I use some scripts from Theo Hultberg (http://
developer.iconara.net) that formats the HTML output from doxygen,
although the standard output is quite nice.
--
Matt Ronge
http://www.theronge.com
_______________________________________________
Do not post admin requests to the list. They will be ignored.
Cocoa-dev mailing list (email@hidden)
Help/Unsubscribe/Update your Subscription:
This email sent to email@hidden