Subject: Re: History of Comment Style & Names
From: rpw3@rpw3.org (Rob Warnock)
Date: Tue, 22 Nov 2005 04:56:32 -0600
Newsgroups: comp.lang.lisp
Message-ID: <zYSdnQusJvL9ZB_enZ2dnUVZ_tydnZ2d@speakeasy.net>
Ingvar  <ingvar@hexapodia.net> wrote:
+---------------
| Ulrich Hobelmann <u.hobelmann@web.de> writes:
| > Good question.  I'm also never sure how many ;s to use.  AFAIK for
| > one-liners it's just one ; and for block comments sometimes two,
| > sometimes three, sometimes four ;s.
| 
| Somewhen, somewhere, I read that the following should be used:
|  ; is for short comments tabbed towards the right from end-of-code
|  ;; is for short comments indented as the shource they refer to
|  ;;; is for comments starting on the beginning of the line
|  ;;;; is for comments at the top of a file, covering the whole file
+---------------

Well, one such "somewhere" is the CLHS itself:  ;-}

    http://www.lispworks.com/documentation/HyperSpec/Body/02_ddb.htm
    2.4.4.2 Notes about Style for Semicolon

    http://www.lispworks.com/documentation/HyperSpec/Body/02_ddbe.htm
    2.4.4.2.5 Examples of Style for Semicolon

These pretty much agree with what Ingvar said, except that in
code I've read the quadruple semicolon is often also used for
major section headings, especially in a large file...


-Rob

-----
Rob Warnock			<rpw3@rpw3.org>
627 26th Avenue			<URL:http://rpw3.org/>
San Mateo, CA 94403		(650)572-2607