TalkPHP - View Single Post

xenon · 06-04-2008, 06:44 PM

You got the idea the wrong way. The page-level doc-block represents a description of the entire file, whilst a class-level doc-block represents a description for that class only. Example:

PHP Code:


			
<?php
/**
 * PAGE LEVEL DOC BLOCK
 *
 * @package main
 */

/**
 * CLASS LEVEL DOC BLOCK
 *
 * @package core
 * @subpackage classes
 */
class TestClass
{
   // ...
}

About your minor question, yes, but you don't need to add a @return void statement to your function comment, void is implied if no return statement is supplied.

06-04-2008, 06:44 PM	#6 (permalink)
xenon The Frequenter Join Date: Dec 2007 Location: Bucharest, Romania Posts: 438 Thanks: 3	You got the idea the wrong way. The page-level doc-block represents a description of the entire file, whilst a class-level doc-block represents a description for that class only. Example: PHP Code: `<?php /** * PAGE LEVEL DOC BLOCK * * @package main / /* * CLASS LEVEL DOC BLOCK * * @package core * @subpackage classes */ class TestClass { // ... }` About your minor question, yes, but you don't need to add a @return void statement to your function comment, void is implied if no return statement is supplied. __________________ I have optimistic thoughts, even though sometimes (if not always) life's a bitch.