[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: Documentation.
|
From: |
Yoshinori K. Okuji |
|
Subject: |
Re: Documentation. |
|
Date: |
Sat, 26 Jun 2004 17:05:44 +0200 |
|
User-agent: |
KMail/1.6.1 |
On Friday 25 June 2004 15:17, Jeroen Dekkers wrote:
> 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.
You are right, if you talk about the API. But I don't think Tomas meant
the API but the design or something similar. For example, "how to add a
new command" is a bit difficult to document in header files, because
the information would be scattered.
Okuji