Re: commenting code using diagrams
Re: commenting code using diagrams
- Subject: Re: commenting code using diagrams
- From: Robert Tillyard <email@hidden>
- Date: Tue, 14 Apr 2009 10:47:38 +0100
| Hello, Julius,
If you use Doxygen there is a way of adding tags that can point to an image file in any format that your browser supports. I put the following line in a Doxygen comment:
\image html images/example.jpg
I know this worked once but I think you may have to manually copy the file to the relevant place on the web-server.
I am about to start a new project where I need this feature again.
Regards, Rob.
On 10 Apr 2009, at 13:54, julius wrote: Hi, is there any way of including diagrams within the comments of my source code (Objective-C in XCode 3.1.2.)? For instance ... code... // compute angle Beta in the diagram // <here I include the diagram> // other comments .... ... more code....
This would be particularly useful when documenting geometrical computations as I find that short meaningful variable names are hard to invent, long names make reading the code difficult and names such as lengthLineAB and angleVectorBC are short and easy to understand if a diagram is available.
At present I have to refer to separate files which I find inconvenient.
Thanks Julius
|
_______________________________________________
Do not post admin requests to the list. They will be ignored.
Xcode-users mailing list (email@hidden)
Help/Unsubscribe/Update your Subscription:
This email sent to email@hidden