EPICS Controls 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  2019  2020  2021  2022  2023  2024  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  2019  2020  2021  2022  2023  2024 
<== Date ==> <== Thread ==>

Subject: Re: EPICS source Documentation
From: Andrew Johnson <[email protected]>
To: David Dudley <[email protected]>
Cc: [email protected]
Date: Fri, 08 Sep 2006 15:32:27 -0500
David Dudley wrote:
I will agree, "... Code always tells the truth.  Comments sometimes
do not...". However, a little comment block here and there, saying
something along the line of "... in this block, the code is intended
to do <such - and -such...>, that sort of points you in the direction
of where you want to go, even if the comment is not 100% direct,
would be useful most of the time.

I agree with you completely David, although I have just come across a counter example which illustrates one of Bob's points: Inside the base/src/libCom/osi/os/vxWorks/devLibOSD.c file there are two identical comments that say:


    /*
     * this global variable exists in the nivxi library
     */

There are no global variables used in the two routines containing the comment, and the code has nothing to do with any National Instruments' VXI library anyway!

- Andrew
--
There is considerable overlap between the intelligence of the smartest
bears and the dumbest tourists -- Yosemite National Park Ranger

References:
RE: EPICS source Documentation David Dudley

Navigate by Date:
Prev: RE: EPICS source Documentation Dalesio, Leo `Bob`
Next: Re: Build failure under QNX 6.1 David Eisert
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  2019  2020  2021  2022  2023  2024 
Navigate by Thread:
Prev: RE: EPICS source Documentation Dalesio, Leo `Bob`
Next: "Best Pratice" on Monitors Bill Nolan
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  2019  2020  2021  2022  2023  2024 
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 ·