Description/Introduction of a file

[samrat_rao]

Hi,

I was wondering if there is any specific methodology of introducing/explaining a file, something like:

;--------------------------------------------------
; $Id: analysis.ncl, v 1.0 2009/09/07 23:05:00 samrat Exp $
;--------------------------------------------------
; File: analysis.ncl
; Author: Samrat Rao
; Indian Institute of Science, Bangalore
; India
; Date: Monday 7th September 2009 23:05:00 I(L)ST
; Description: This is the top-level script for my analysis routines
;--------------------------------------------------

I copied this from a similar file. But i am unable to figure out a fixed pattern to any such introduction, even from source codes.

Could someone help or provide any links?

Thanks.

far as i know you get to decide..

but, be sure and use a line beginning which will mark it as a comment..

--
platinum

[ab@novell.com]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Commenting at the start of a file varies wildly and I do not believe there
is a convention universally used for all languages, though some
conventions are more common than others. One not-just-commenting
convention may be the "shebang" line at the start of scripts:

<code>
#!/bin/bash
*snip rest of code
</code

The first line of a script has this to tell the environment which
interpreter to use to parse the file (/bin/bash in this case, or
/usr/bin/perl in other cases). This is technically a comment but it's a
special comment and it must be the very first line of the file.

Otherwise in my files I include a few things.... the author's name (me),
my e-mail address, a version number (typically including a date in an
appropriate format at the end, such as 20090908143400Z), and then a
description of what it is. The use of dashes to create "sections" is, to
me, just fluff and I do not do it but if it floats your boat then go with it.

Good luck.





platinum wrote:
> far as i know you get to decide..
>
> but, be sure and use a line beginning which will mark it as a comment..
>
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2.0.9 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/

iQIcBAEBAgAGBQJKpl2CAAoJEF+XTK08PnB5nJsQAIZldr8YMZ alJ3oouZzbq17B
8Vu/eIlNxnojV3I46S58CL3hG3/LbecVinB4JwMWbFCTh5plgoF/jRPcQQeMl4LU
5+CEtiC1zG5FH4iI1Z2BKx58oH9NZWGTBDROfT0lGOI3obh0dg cxHpIlhvhnHh6K
iw7ulJoBFi0y4A7Dhhuga/GNneWoRosGv0t9RNGVOHyEB20PQXr+aVP2rUmw2DzJ
VT3XpAtZ2KmLk2mvJJNGERMiebPWXGOgFKMjTPjcPivoREzcCU c/D4ad1NeQiaqj
JjR88RRJH9Ih/LlMekuvhx9/0Z75EcaHus+JVmAzBVJgkj4JFJbYYf0/4CU/YGLI
m7Y23TK/9C3W0/k9tcm7cwFFfUS+/Om1vAyD8BbuACZsxzJdKRqHTTi6gMwOQEGa
l/dSwzz4rm28WdzRIs0MZz3umOcolYbP2E5nouqgSHfBd0Bj/Md9NtluoN7xksXN
urdhMm0oUE0nhDIqPBRbxBudP6HoK9rcnGhGNtx7FSCLNJUD4w 6od6rY5AIWYKsC
Gw6FRsgxYlEvEU5dxXIuYNxPUW4E8t7jwEMaL6WRxfqYQ26xvP aPc1d/4L6p7+nZ
sjwPSXo8624T8RWfg0GgoX+Ygvuuw9VHz9D/vC1w7aVd3D63bSbZAML+KWipZ+Se
k6m6csAsBUyrzNgb+oJY
=eHgo
-----END PGP SIGNATURE-----

[samrat_rao]

Thanks platinum and ab. I guess that i'll find my sweet way of describing my file