Re: commenting code using diagrams
Re: commenting code using diagrams
- Subject: Re: commenting code using diagrams
- From: Louis Demers <email@hidden>
- Date: Fri, 10 Apr 2009 09:20:38 -0400
On 10-Apr-09, at 08: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....
I think that if you use Doxygen to document your code there are
options to include graphics/diagrams using the syntax from Dot.
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
http://juliuspaintings.co.uk
_______________________________________________
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
Louis Demers eng.
www.obzerv.com
_______________________________________________
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