Argonne National Laboratory

Experimental Physics and
Industrial Control System

1994  1995  1996  1997  1998  1999  2000  2001  2002  2003  2004  2005  <20062007  2008  2009  2010  2011  2012  2013  2014  2015  2016  2017  2018  Index 1994  1995  1996  1997  1998  1999  2000  2001  2002  2003  2004  2005  <20062007  2008  2009  2010  2011  2012  2013  2014  2015  2016  2017  2018 
<== Date ==> <== Thread ==>

Subject: EPICS source Documentation
From: "David Dudley" <DavidDu@cctexas.com>
To: <tech-talk@aps.anl.gov>
Date: Fri, 08 Sep 2006 11:20:59 -0500
Just a strange question, but I've noticed a tendency of all the source files to not have any comments (or very few) in them regarding what they do.

Is this a standard I've just never known about?
Typically, source(s) that I compose end up having as much in comments (or more) than in code, for the simple reason that I can't concentrate on one component at a time, and I might work some now, and some two or three days from now (and I've slept between then and now).

I get so busy with the multiple things I have to do, that if I don't comment the hell out of what I write, I might have to spend quite a bit of time decoding what I was doing before I needed to switch.

Is this the normal style for EPICS, or would there be any objections to comments being added to some of the files as I work with/on them?

David Dudley

BEGIN:VCARD
VERSION:2.1
X-GWTYPE:USER
FN:David Dudley
TEL;WORK:880-3740
ORG:;MIS
TEL;PREF;FAX:880-3741
EMAIL;WORK;PREF;NGW:DavidDu@cctexas.com
N:Dudley;David
END:VCARD


Replies:
Re: EPICS source Documentation Kay-Uwe Kasemir
RE: EPICS source Documentation - Bloviation inside - don't open unless you want to waste the time Dalesio, Leo `Bob`
Re: EPICS source Documentation Andrew Johnson
Re: EPICS source Documentation Paul Joireman

Navigate by Date:
Prev: Re: Build failure under QNX 6.1 David Eisert
Next: Re: Build failure under QNX 6.1 David Dudley
Index: 1994  1995  1996  1997  1998  1999  2000  2001  2002  2003  2004  2005  <20062007  2008  2009  2010  2011  2012  2013  2014  2015  2016  2017  2018 
Navigate by Thread:
Prev: Re: Looking for an IOC for Wiener PL512 Bertrand H.J. Biritz
Next: Re: EPICS source Documentation Kay-Uwe Kasemir
Index: 1994  1995  1996  1997  1998  1999  2000  2001  2002  2003  2004  2005  <20062007  2008  2009  2010  2011  2012  2013  2014  2015  2016  2017  2018 
ANJ, 02 Sep 2010 Valid HTML 4.01! · Home · News · About · Base · Modules · Extensions · Distributions · Download ·
· Search · EPICS V4 · IRMIS · Talk · Bugs · Documents · Links · Licensing ·