SUMMARY: Comments in a program?

From: Konstantin Rozinov <>
Date: Sat Nov 17 2001 - 17:43:20 EST

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

Program name
file name
time of completion
working time
advices in advance
and so on

Thanks a bunch!


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 mailing list
Received on Sat Nov 17 16:46:18 2001

This archive was generated by hypermail 2.1.8 : Thu Mar 03 2016 - 06:42:28 EST