OpenEuphoria

Commentary Convention: Prolog

• Posted by "Lucien T. Elliott" <lucien at NY.FRONTIERCOMM.NET> Oct 07, 1996
• 1939 views

Ok marciel,

ill be first in the barrel with the following PROLOG commentary
model.  i keep this in \euphoria\include\prolog.mdl and when
creating a new program, i copy it into the new file and begin
finding and changing the ?'s.  granted, this is a bit much for a
one man shop to keep properly updated (who among us is
not just a bit lazy when it comes to documentation?)..

-- * ?company_name
                                          ?filename.ext
-- * System      : ?system_title
-- * Component   : ?component_title
-- * Written by  : ?author
                                              ?m/dd/yy
-- * Copyright   : ?who owns the copyright to this program & since when
-- * Description : ?brief functional description of this program

-- * External Functions:

        ? list of externally defined functions (may also be include statements)

-- * Internal Functions:

        ? list of internally defined functions

-- * Global Variables Defined:

        ? list of global variables/constants defined in this program

-- * Global Variables Used:

        ? list of global variables/constants used in this program

---------------------------------------------------------------------------
-- * MODIFICATION HISTORY
                             BY      DATE
-- * ?
                                                             ?     ?m/dd/yy

-- BEGIN CODE
Lucien T. Elliott
Warwick Information Technology
29 Hawthorn Avenue
Warwick, NY 10990
(914) 986 5139
URL //ny.frontiercomm.net/~lucien
EMAIL lucien at ny.frontiercomm.net