:: Re: [DNG] "Common knowledge?"-quest…
Αρχική Σελίδα
Delete this message
Reply to this message
Συντάκτης: Rainer Weikusat
Ημερομηνία:  
Προς: dng
Αντικείμενο: Re: [DNG] "Common knowledge?"-question
Steve Litt <slitt@???> writes:
> Rainer Weikusat <rainerweikusat@???> wrote:
>
>> Can the effect of the following C function
>>
>> static void print_start(char const *name, char const *what)
>> {


[...]

>> }
>>
>> be considered obvious or should it rather get an explanation?
>
> Hi Rainer,
>
> Others have pointed out potential coding problems, but I'm just going
> to answer your question about need for comments. In my opinion, the
> preceding function is short enough to document itself *if and only if*
> the function gets a much more descriptive name. Descriptive of what it
> does and how it's used.


The naming is indeed poor. Thank you for pointing this out.