• Open Menu Close Menu
  • Apple
  • Shopping Bag
  • Apple
  • Mac
  • iPad
  • iPhone
  • Watch
  • TV
  • Music
  • Support
  • Search apple.com
  • Shopping Bag

Lists

Open Menu Close Menu
  • Terms and Conditions
  • Lists hosted on this site
  • Email the Postmaster
  • Tips for posting to public mailing lists
Re: commenting code using diagrams
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: commenting code using diagrams


  • Subject: Re: commenting code using diagrams
  • From: Jonathon Kuo <email@hidden>
  • Date: Fri, 10 Apr 2009 13:34:52 -0700


On Apr 10, 2009, at 7:35 AM, Paul Walmsley wrote:

Sean McBride wrote:
On 4/10/09 1:54 PM, julius said:


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....



Though not as good as a real diagram, sometimes I find the wealth of Unicode characters helpful in comments. There are all kinds of mathematical characters and line and shape chars that you can use in your comments.


Another possibility is to use an ASCII art editor, eg http://www.jave.de/

If you use doxygen you can wrap this in \verbatim ... \endverbatim tags so that it will preserve the format in the HTML output.


Is there a tool that will ASCIIise existing diagrams/graphics into a commentable block of text characters?

_______________________________________________
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


  • Follow-Ups:
    • Re: commenting code using diagrams
      • From: Serg Koren <email@hidden>
References: 
 >commenting code using diagrams (From: julius <email@hidden>)
 >Re: commenting code using diagrams (From: "Sean McBride" <email@hidden>)
 >Re: commenting code using diagrams (From: Paul Walmsley <email@hidden>)

  • Prev by Date: Re: commenting code using diagrams
  • Next by Date: Re: commenting code using diagrams
  • Previous by thread: Re: commenting code using diagrams
  • Next by thread: Re: commenting code using diagrams
  • Index(es):
    • Date
    • Thread