From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 12713 invoked by alias); 6 Jan 2011 14:17:17 -0000 Received: (qmail 12699 invoked by uid 22791); 6 Jan 2011 14:17:16 -0000 X-SWARE-Spam-Status: No, hits=-2.0 required=5.0 tests=AWL,BAYES_00 X-Spam-Check-By: sourceware.org Received: from rock.gnat.com (HELO rock.gnat.com) (205.232.38.15) by sourceware.org (qpsmtpd/0.43rc1) with ESMTP; Thu, 06 Jan 2011 14:17:11 +0000 Received: from localhost (localhost.localdomain [127.0.0.1]) by filtered-rock.gnat.com (Postfix) with ESMTP id 68BF52BAC1D; Thu, 6 Jan 2011 09:17:09 -0500 (EST) Received: from rock.gnat.com ([127.0.0.1]) by localhost (rock.gnat.com [127.0.0.1]) (amavisd-new, port 10024) with LMTP id pXL39xkezuok; Thu, 6 Jan 2011 09:17:09 -0500 (EST) Received: from joel.gnat.com (localhost.localdomain [127.0.0.1]) by rock.gnat.com (Postfix) with ESMTP id E79082BAC18; Thu, 6 Jan 2011 09:17:08 -0500 (EST) Received: by joel.gnat.com (Postfix, from userid 1000) id 77FC81459AD; Thu, 6 Jan 2011 18:16:59 +0400 (RET) Date: Thu, 06 Jan 2011 14:17:00 -0000 From: Joel Brobecker To: Yao Qi Cc: gdb-patches@sourceware.org Subject: Re: FYI: My Coding Style cheat-sheet on the Wiki Message-ID: <20110106141659.GD2351@adacore.com> References: <20110106083223.GC2361@adacore.com> <4D25CA81.3040102@codesourcery.com> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <4D25CA81.3040102@codesourcery.com> User-Agent: Mutt/1.5.20 (2009-06-14) Mailing-List: contact gdb-patches-help@sourceware.org; run by ezmlm Precedence: bulk List-Id: List-Subscribe: List-Archive: List-Post: List-Help: , Sender: gdb-patches-owner@sourceware.org X-SW-Source: 2011-01/txt/msg00128.txt.bz2 > > /* 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