Topic: Lisp headers

[hudster]

Is there a standard header for a lisp routine.

I'm writing a few and was wondering what I should put at the top.

at the moment I put this.

Code: [Select]

;;;
;;;Autolisp routine to do something
;;;
;;;enter COMMAND NAME HERE to run
;;;

[Mark]

The only thing that I've seen as far as a standard goes is _this_. I would use what ever makes sense to you, after all you are the one that has to decipher what it all means and the best way to find the info within the files.

[SPDCad]

I always use something like the following, but like Mark's says its really up to you to document your work.  After all it is usually you who will be modifying the code at a later date and it good to know what you did the first time around.

;============================AlphaCNT.lsp =======================
;  By: SPD                                                                      Date: 9 OCT 2002  
;  Purpose: To convert a number into its equalvalent a alpha-numerical value.  
;  Sub_Programmes: -None                                                      
;  Requirements: -Num = Alpha number to convert (ie. 10)                      
;                        -PAR = Small or Capital output. (ie. 1 gives J)              
;  Returns: -the converted number                                                              
;====================================================================

[hudster]

Thanks for the info.

What I was doing was just putting a title and date on it.

I'm using this now.

Code: [Select]

;;;
;;; TITLE:
;;;
;;; Copyright (C) 2005 by Andy Hudson
;;;
;;; Permission to use, copy, modify, and distribute this
;;; software and its documentation for any purpose and without
;;; fee is hereby granted
;;;
;;; THIS SOFTWARE IS PROVIDED "AS IS" WITHOUT EXPRESS OR
;;; IMPLIED WARRANTY. ALL IMPLIED WARRANTIES OF FITNESS FOR ANY
;;; PARTICULAR PURPOSE AND OF MERCHANTABILITY ARE HEREBY
;;; DISCLAIMED.
;;;
;;; Andy Hudson
;;; April 2005
;;;
;;;-------------------------------------------------------------
;;; Description:
;;;
;;;
;;;
;;;
;;;

[Keith™]

Hudster, that is pretty close to what I use, except I typically include my full contact information in the header so there will be no question about who it belongs to or how to contact me.

[Kerry]

I keep six honest serving-men
      (They taught me all I knew);
Their names are What and Why and When
And How and Where and Who.

(RudyardKipling, from "The Elephant's Child" in Just So Stories).

It's surprising what how much this applies to.

kwb

[CADaver]

More completely ...

I keep six honest serving-men
(They taught me all I knew);
Their names are What and Why and When
And How and Where and Who.
I send them over land and sea,
I send them east and west;
But after they have worked for me,
I give them all a rest.

I let them rest from nine till five,
For I am busy then,
As well as breakfast, lunch, and tea,
For they are hungry men;
But different folk have different views:
I know a person small -
She keeps ten million serving-men,
Who get no rest at all!
She sends 'em abroad on her own affairs.
From the second she opens her eyes -
One million Hows, two million Wheres,
And seven million Whys!

The Elephant's Child.

VERY complete

[Keith™]

CADaver .. is that posting covered in the fair use clause of copyright law?

[CADaver]

CADaver .. is that posting covered in the fair use clause of copyright law?

According to my Literary Encyclopedia, the work is public domain.

EDITED

Read that as Public Domain "in the USA, other countries may vary".

EDITED #2

HERES's another, this one from Australia