05-31-2008, 04:58 PM
|
#1 (permalink)
|
|
is cute and cuddly
Join Date: Mar 2008
Location: Vegas, Baby
Posts: 963
Thanks: 31
|
phpDoc
So I finally made the jump from using my pseudo docblock format of commenting to making it phpDoc compliant. I haven't finished recommenting everything yet, so I haven't run it through phpDoc, but I have a question.
In one of my books which has a chapter on phpDoc, it states
Quote:
|
A file comment should be the first DocBlock in a document. It should contain a @package tag, and it should not directly precede a coding construct. In other words, if you add a file-level Docblock, you should ensure that you also add a class-level comment before the first class declaration.
|
So here's my question. That makes it sound like a class level DocBlock should almost if not directly follow a file level DocBlock. What if I have an include and a few commands first, ie:
PHP Code:
..end of file-level Docblock */
include($_SERVER['DOCUMENT_ROOT'].'/bin/lib/tuatara.config.php');
// Session is instantiated within controller
tuatara::loadEmpty('core', 'session');
// Page Specific
$szCommand = (array_key_exists('cmd', $_GET)) ? $_GET['cmd'] : 'logout';
new controller($szCommand);
/**
* ..start of class-level Docblock..
Is that incorrect?
-m |
|
|
|