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: Kay-Uwe Kasemir <[email protected]>
To: tech talk <[email protected]>
Date: Fri, 08 Sep 2006 12:44:37 -0400

On Sep 8, 2006, at 12:20 , David Dudley wrote:
Just a strange question,
Quite a provocative question, but just about right for a Friday flame war ;-)

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.
The EPICS sources all come from different people.
Some of the newer sources, especially those meant to be used by others,
actually have nice comments, like osiTime.h.
I think that's also because newer IDEs for C++ or especially Java
help a lot with the source code generation and navigation,
and systems like doxygen or javadoc turn comments into neat
API descriptions, so people who've used them now tend to
add more comments.
On the other hand, some of the older EPICS sources show the
heritage of being created with vi on serial line terminals,
where every typed character was carefully reconsidered,
and comments where considered harmful to the readability
of your code.

-Kay




References:
EPICS source Documentation David Dudley

Navigate by Date:
Prev: Re: VME Bus Error handling on MVME3100 and MVME6100 boards Till Straumann
Next: RE: EPICS source Documentation - Bloviation inside - don't open unless you want to waste the time Dalesio, Leo `Bob`
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: EPICS source Documentation David Dudley
Next: RE: EPICS source Documentation - Bloviation inside - don't open unless you want to waste the time Dalesio, Leo `Bob`
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 ·