| Re: Looking for IDL code documentation standards [message #44057 is a reply to message #44055] |
Mon, 16 May 2005 12:06   |
JD Smith
Messages: 850
Registered: December 1999
|
Senior Member |
|
|
On Mon, 16 May 2005 12:58:25 -0500, Craig Markwardt wrote:
>
> Michael Wallace <mwallace.no.spam@no.spam.swri.edu.invalid> writes:
>>>> Is there somewhere in the IDL guides or on the web that the IDL code
>>>> documentation standards are located? I've been able to piece together
>>>> some of it from IDL code examples, but I'd like to see a definitive
>>>> guide.
>>> So would I! But, alas, you and I would be the only
>>> ones reading it. :-(
>>
>> I too would be reading it. That makes three of us. I actually asked
>> a very similar question of this newsgroup many moons ago and since
>> then I've gone on to develop my own style so that I'm at least
>> internally consistent within my own code. RSI can't even claim that.
>
> A long-ago contributor, Mark Schienle, once posted a link to his own
> style guide, which may be kind of what you are after. Unfortunately
> his web site, ivsoftware.com, is now defunct.
>
> I use idlwave to enforce indentation, which leads to consistent
> appearance of comments.
>
> I have a documentation template I use, which I could post, but I also
> deviate from my own template :-)
IDL coding style tends to be quite personal, even for RSI programmers.
Take a quick perusal through !DIR/lib and notice that they can't even
agree on whether to indent the body of routines!
I whipped up this example coding standard, trivially enforceable by
IDLWAVE:
http://idlwave.org/idlwave_template.pro.html
Hope it is of some use.
JD
|
|
|
|
comp.lang.idl-pvwave archive
Members
Search
Help
Login
Home
