[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [Groff] Overview, Sept. 2014
From: |
Ulrich Lauther |
Subject: |
Re: [Groff] Overview, Sept. 2014 |
Date: |
Fri, 12 Sep 2014 00:16:21 +0200 |
User-agent: |
Mutt/1.5.23 (2014-03-12) |
On Thu, Sep 11, 2014 at 05:46:22PM -0400, James K. Lowden wrote:
[ ... ]
> If by "all about" Urich meant a sentence or two, sure, a comment block
> is fine. If by "all about" he meant a description of the semantics of
> the public interface (which is what I thought he meant) then ISTM that
> belongs in a manual, not in the source code. N'est-ce pas?
>
I was NOT referring in any way to semantics or public interface, but to the
inner
workings of the implementation and how to make it understandable to a later
maintainer
(or to the original programmer after a few years).
That should have been clear from the previous discussion on programming style.
To give an example:
The seemingly trivial string searching function strstr() can be implemented
using
sophisticated algorithms like Rabin–Karp algorithm, Knuth–Morris–Pratt
algorithm,
Boyer–Moore string search, ...
Their description belongs NOT into the man-page (though a hint about the
time-complexity would be nice).
But to understand the source code would be impossible without explanations and
pointers
to the relevant literature.
ulrich
- Re: [Groff] Overview, Sept. 2014, (continued)
- Re: [Groff] Overview, Sept. 2014, Ingo Schwarze, 2014/09/10
- Re: [Groff] Overview, Sept. 2014, Ulrich Lauther, 2014/09/10
- Re: [Groff] Overview, Sept. 2014, Peter Schaffter, 2014/09/10
- Re: [Groff] Overview, Sept. 2014, Steffen Nurpmeso, 2014/09/11
- Re: [Groff] Overview, Sept. 2014, James K. Lowden, 2014/09/11
- Re: [Groff] Overview, Sept. 2014, Ulrich Lauther, 2014/09/11
- Re: [Groff] Overview, Sept. 2014, Clarke Echols, 2014/09/11
- Re: [Groff] Overview, Sept. 2014, James K. Lowden, 2014/09/11
- Re: [Groff] Overview, Sept. 2014,
Ulrich Lauther <=
- [Groff] Documenting the Source. (Was: Overview, Sept. 2014), Ralph Corderoy, 2014/09/11
- Re: [Groff] Documenting the Source., Werner LEMBERG, 2014/09/12
- Re: [Groff] Overview, Sept. 2014, Ingo Schwarze, 2014/09/14
Re: [Groff] Overview, Sept. 2014, Peter Schaffter, 2014/09/10
Re: [Groff] Overview, Sept. 2014, Bertrand Garrigues, 2014/09/11