| Re: Looking for IDL code documentation standards [message #44059 is a reply to message #44058] |
Mon, 16 May 2005 10:58   |
Craig Markwardt
Messages: 1869
Registered: November 1996
|
Senior Member |
|
|
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 :-)
Craig
--
------------------------------------------------------------ --------------
Craig B. Markwardt, Ph.D. EMAIL: craigmnet@REMOVEcow.physics.wisc.edu
Astrophysics, IDL, Finance, Derivatives | Remove "net" for better response
------------------------------------------------------------ --------------
|
|
|
|
comp.lang.idl-pvwave archive
Members
Search
Help
Login
Home
