[Fwd: SUMMARY: Comments in a program?]

Konstantin Rozinov ukon at speakeasy.org
Sat Nov 17 17:51:58 EST 2001


Sorry, but forgot to mention that Sergio Gelato also helped a lot with his
ideas:

"For the side question: read the man page for sccs(1).
Note that most sane people use RCS (or CVS, which is based on RCS)
rather than SCCS nowadays. The ID strings in RCS look somewhat
different, but the principle is the same.

Coding and commenting standards: essentially every software shop
has its own. No universality here. Do a "groups" search at google.com
if you want to read the many discussions of this topic that have
taken place in various comp.lang.* newsgroups over the years.
Or look at source code from various places such as:
        GNAT (the GNU Ada 95 compiler);
        many numerical libraries at netlib.org;
        Perl modules in the CPAN repositories;
        LaTeX packages using docstrip for documentation;
        D.E.Knuth's literate programming tools."

Konstantin Rozinov

Konstantin Rozinov wrote:

> Hi,
>
> Thanks to all those who responded:
> Ozgur C. Demir
> Anderson McCammont
> Wildemann Markus
> David Evans
>
> The general solution was that these comments were not created by hand,
> instead they were/could be created by:
> -m4 macros
> -SCCS - see sccs-get(1)
> -RCS - see ident(1)
> -CVS
> -Third-party software: ClearCase, PerForce, PVCS
>
> Markus pointed out that these comments are used by /usr/bin/css/what:
> # /usr/ccs/bin/what /etc/init.d/autofs
> /etc/init.d/autofs:
>         autofs  1.4     96/08/20 SMI
>
> There seems to be no standard in terms of how these comments are laid out.
> But the following information (to be put into comments at top) was
> suggested:
>
> Author
> Program name
> file name
> time of completion
> working time
> version
> advices in advance
> and so on
>
> Thanks a bunch!
>
> Konstantin
>
> Original Question:
>
> Konstantin Rozinov wrote:
>
> > Hi Gurus,
> >
> > I'm sure this is not the right list for this question but maybe some of
> > you know this?  I would like to know if there is a specific
> > format/standard that is followed in terms of commenting your program (in
> > the beginning of each file) with information including your name, dept,
> > company, date, program version, description, directions, etc...
> >
> > Also a side question: in almost all the scripts provided by sun (i.e. in
> > /etc/init.d/) they have the following style:
> >
> > #ident  "@(#)dhcp       1.17    99/10/23 SMI"
> > #ident  "@(#)ncad       1.1     00/02/08 SMI"
> > #ident  "@(#)rpc        1.46    99/09/22 SMI"
> >
> > is this created by a script? by hand? what are the different columns?
> > what is it used for other than identification purposes?
> >
> > Thanks a bunch!
> >
> > Will summarize,
> >
> > Konstantin
> >
> > _______________________________________________
> > sunmanagers mailing list
> > sunmanagers at sunmanagers.org
> > http://www.sunmanagers.org/mailman/listinfo/sunmanagers

_______________________________________________
sunmanagers mailing list
sunmanagers at sunmanagers.org
http://www.sunmanagers.org/mailman/listinfo/sunmanagers




More information about the summaries mailing list