Re: Doxygen comments in C++ source

[email protected]
Newsgroups gmane.comp.audio.supercollider.devel
Message-ID <CAF2oGs0EtF5EAym76QKcaeowdVVNMXX6+ED49V3W0mFKQ84gog@mail.gmail.com>
On Wed, Feb 7, 2018 at 12:34 PM, <[email protected]> wrote:

>
> > Also, by following the principle of: "if you find yourself documenting a
> piece of code within a function, stop, take that code out into a new
> function whose name is the text of the comment", you will find you often
> don't need to document functions. They say what they do.
>
> When the function is a 500+ LOC behemoth with no unit tests and several
> single-letter-name variables, that's simply not realistic advice.
>

Sure it is. It is the way you make a 500 line function become a number of
25 line functions.

-- 
--- james mccartney
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.