Periods in docblock summaries
| From: | Michael Gauthier | Date: | Thu, 15 May 2008 01:10:32 +0000 |
| Subject: | Periods in docblock summaries | ||
| Groups: | php.pear.dev | ||
| Request: | Send a blank email to pear-dev+get-50116@lists.php.net to get a copy of this message | ||
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.
This is different from Javadoc where the first sentence is considered
the summary, and it breaks documentation generators based on Javadoc
syntax.
Mike
[1] http://pear.php.net/manual/en/standards.sample.php