This is the mail archive of the gdb-patches@sourceware.org mailing list for the GDB project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

Re: FYI: My Coding Style cheat-sheet on the Wiki


> > /* The maximum number of tasks known to the Ada runtime */
> > static const int MAX_NUMBER_OF_KNOWN_TASKS = 1000;
> 
> What is the expected/correct format of comment here?  Isn't ended with
> period and two spaces?  If we still follow the "period and two spaces"
> schema here,  I'll update this wikipage and source code to reflect this.

(blush) Worst example I could have chosen... This is bad.
Yes, you are correct, a period and 2 spaces would be required.
It's not entirely obvious, since you can argue that the comment
is not a sentence.  However, for something that long, either we
make it a real sentence, or we think of it as a sentence.  Only
in the case of very short comment can we get away with no period
at the end of comment...

Thanks for catching this.  I will fix the code...

-- 
Joel


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]