[OT?] Commenting question

From: Joona I Palaste (palaste_at_cc.helsinki.fi)
Date: 06/30/04

Next message: Andrew Chambers: "Re: recursive classes"
Previous message: Andrew Thompson: "Re: Reading Esri shapefile cordinates with Java"
Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]

Date: 30 Jun 2004 18:25:33 GMT

Should comments in production software source code contain references to
in-house documents, or in my case, Bugzilla bugs? The argument for it is
that it makes it easier for developers to know what the code is about,
and customers who don't have access to in-house documents won't be
seeing the source code either. The argument against it is that source
code does not depend on, nor is tied to, in-house documents or Bugzilla
bugs. These in-house things could change, or even cease to exist,
without the source code having to be changed.

-- 
/-- Joona Palaste (palaste@cc.helsinki.fi) ------------- Finland --------\
\-- http://www.helsinki.fi/~palaste --------------------- rules! --------/
"There's no business like slow business."
   - Tailgunner

Next message: Andrew Chambers: "Re: recursive classes"
Previous message: Andrew Thompson: "Re: Reading Esri shapefile cordinates with Java"
Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]

Relevant Pages

Re: [OT?] Commenting question
... > Should comments in production software source code contain references to ... > in-house documents, or in my case, Bugzilla bugs? ... > code does not depend on, nor is tied to, in-house documents or Bugzilla ... references to terms defined in these higher level docs may be appropriate as ...
(comp.programming)
Re: [OT?] Commenting question
... > Should comments in production software source code contain references to ... > in-house documents, or in my case, Bugzilla bugs? ... > code does not depend on, nor is tied to, in-house documents or Bugzilla ... references to terms defined in these higher level docs may be appropriate as ...
(comp.lang.java.programmer)
Re: [OT?] Commenting question
... > Should comments in production software source code contain references to ... > in-house documents, or in my case, Bugzilla bugs? ... > and customers who don't have access to in-house documents won't be ...
(comp.lang.java.programmer)
Re: [OT?] Commenting question
... > Should comments in production software source code contain references to ... > in-house documents, or in my case, Bugzilla bugs? ... > and customers who don't have access to in-house documents won't be ...
(comp.lang.java.programmer)
Re: Any good free cross Plattform lisps ?
... I was at the AI Lab as a Lisp Machine developer, ... Then after I left MIT, ... open source (that is, customers can see the source code and modify it, ... So they continued to provide the source code to MIT (and all their ...
(comp.lang.lisp)