Re: Periods in docblock summaries

2008/5/14 Michael Gauthier <mike@silverorange.com>: > Hello, > > What is the reason for making the first sentence of class/method > docblocks not end with a period? The PEAR documentation [1] states: > > The first line of any docblock is the summary. Make them one short > sentence, without a period at the end. Summaries for classes, properties > and constants should omit the subject and simply state the object, > because they are describing things rather than actions or behaviors. To give a quick personal answer to this I'd say it's because summaries which are usually constituted of titles which ,according the English grammar, do not and must not contain dots. I believe it is the same for French grammar, and if I'm not mistaking, summaries usually do not contain "dots" (Even though I'm sure it does happen sometimes) I'd say this would be the answer the closest to why this choice has been made. I may be mistaken but I think this reason is quite plausible. I'll try to track down the reason why, if anyone has a better reason... please tell :) -- Slan, David