Back to the main page

Mailing List Logs for ShadowRN

From: Robert Watkins robert.watkins@******.com
Subject: [semi-OT] programming languages' evolution
Date: Tue, 2 Feb 1999 09:19:14 +1000
Mark A Shieh writes:
> Sure, definitely. But does it really make a difference
> whether the documentation consists of some comments at the beginning
> of each relevant section of code and some general advice in a text
> document, or whether javadoc has turned the documents into html form?

Umm... yes it does. If the source of the documentation is in a seperate
location from the source of the program, then changes in one are harder to
reflect in the other, due to extra effort. In many cases (especially with
maintainence programming), the changes won't be carried over. Embedded the
source of the documentation in the program source, and you'll at least make
the effort smaller, if not remove it entirely.

--
Duct tape is like the Force: There's a Light side, a Dark side, and it
binds the Universe together.
Robert Watkins -- robert.watkins@******.com

Disclaimer

These messages were posted a long time ago on a mailing list far, far away. The copyright to their contents probably lies with the original authors of the individual messages, but since they were published in an electronic forum that anyone could subscribe to, and the logs were available to subscribers and most likely non-subscribers as well, it's felt that re-publishing them here is a kind of public service.