comp.lang.idl-pvwave archive: archive » Re: Comments on Coding Style

Home » Public Forums » archive » Re: Comments on Coding Style

Show: Today's Messages :: Show Polls :: Message Navigator
E-mail to friend

Re: Comments on Coding Style [message #70674 is a reply to message #70673]

Thu, 29 April 2010 12:38

penteado
Messages: 866
Registered: February 2018

Senior Member
Administrator

On Apr 29, 4:26 pm, Aram Panasenco <panasencoa...@gmail.com> wrote:
> I am going to try and use only one header per class that will describe
> the entire class interface. I am using non-standard tags (Name, Design
> Details, Abstraction, Syntax, and Public Methods) instead of the more
> standard (Name, Purpose, Category, Superclasses, Subclasses, Syntax). Is
> that a bad change? What would you like to see different about the header?

If you use one of the standard formats (and tags) for the comments,
then you can use IDLdoc to generate nice documentation pages (which
include very useful features like links and search). If you are not
familiar with it, see

http://idldoc.idldev.com/

Also, using one of the standard formats allows the Workbench to show
the help for the routine.

Report message to a moderator

[Message index]

		Re: Comments on Coding Style By: David Fanning on Thu, 29 April 2010 13:59
		Re: Comments on Coding Style By: Michael Galloy on Thu, 29 April 2010 13:52
		Re: Comments on Coding Style By: Aram Panasenco on Thu, 29 April 2010 13:17
		Re: Comments on Coding Style By: Aram Panasenco on Thu, 29 April 2010 13:10
		Re: Comments on Coding Style By: David Fanning on Thu, 29 April 2010 12:42
		Re: Comments on Coding Style By: penteado on Thu, 29 April 2010 12:38
		Re: Comments on Coding Style By: Aram Panasenco on Thu, 29 April 2010 12:26
		Re: Comments on Coding Style By: David Fanning on Thu, 29 April 2010 06:05
		Re: Comments on Coding Style By: Maarten[1] on Thu, 29 April 2010 01:44
		Re: Comments on Coding Style By: Aram Panasenco on Thu, 29 April 2010 16:30
		Re: Comments on Coding Style By: Michael Galloy on Thu, 29 April 2010 14:17

Previous Topic:	AO, SAO
Next Topic:	Writing *.csv files

-=] Back to Top [=-

[ Syndicate this forum (XML) ] [

] [

]

Current Time: Sat Oct 11 10:01:46 PDT 2025

Total time taken to generate the page: 0.71976 seconds