[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Documentation.

From: Jeroen Dekkers
Subject: Re: Documentation.
Date: Fri, 25 Jun 2004 15:17:14 +0200
User-agent: Wanderlust/2.10.1 (Watching The Wheels) SEMI/1.14.6 (Maruoka) FLIM/1.14.6 (Marutamachi) APEL/10.6 Emacs/21.3.50 (i686-pc-linux-gnu) MULE/5.0 (SAKAKI)

At Fri, 25 Jun 2004 00:03:53 +0200,
Yoshinori K. Okuji wrote:
> Regardless of whatever tool you use, the most important thing in 
> documentation is "not to make it out of dated". This is really 
> difficult. Indeed, I gave up keeping information on internals of GRUB 
> Legacy in the manual. Maintaining good documentation costs the same as 
> maintaining good code. So, I'd recommend that you keep your 
> documentation as simple as you can.

The best way to document the internals is in the code, so that when
the code changes the comments change with it. To describe the
interfaces you can write verbose header files for example.

Jeroen Dekkers

reply via email to

[Prev in Thread] Current Thread [Next in Thread]