codeigniter中的Phpdoc页面级错误

Question

嗨我已经使用codeigniter创建了一个项目。现在我正在尝试生成phpdoc。这是我第一次使用phpdoc，我已经阅读了他们的文档和其他教程。当我试图生成我得到错误的名单大多是

....没有页面级文档块，使用@package第一文档块创建一个

和什么也没有发生。但是当我在控制器或模型文件夹内运行phpdoc它的工作原理，但不从根文件夹或应用程序文件夹运行。我哪里错了？

这里是文档块的开始

<?php if (! defined('BASEPATH')) exit('No direct script access allowed'); 
/** 
* 
* Project 1 files 
* 
* @package  Project1 
* @subpackage projectControllers 
* @author  Abhishek Salian 
* @copyright Copyright (c) 2013, AS. 
* @link  http://localhost/project1/ 
* @since  Version 1.0 
*/ 
?> 

对于每一个方法的被检

/** 
* index 
* 
* This loads the index page 
* 
* @access public 
*/ 

错误：

Abhis-MacBook-Pro:~ abhishek$ sudo phpdoc -d /Applications/mamp/htdocs/NewFrontend/ -t /Applications/mamp/htdocs/Docs/ 
PHP Version 5.4.10 
phpDocumentor version 1.4.4 

Parsing configuration file phpDocumentor.ini... 
    (found in /Applications/MAMP/bin/php/php5.4.10/lib/php/data/PhpDocumentor/)... 

done 
Maximum memory usage set at 256M after considering php.ini... 
using tokenizer Parser 
Hidden /Applications/mamp/htdocs/NewFrontend/.DS_Store Ignored 
Hidden /Applications/mamp/htdocs/NewFrontend/.git Ignored 
Hidden /Applications/mamp/htdocs/NewFrontend/.gitignore Ignored 
Hidden /Applications/mamp/htdocs/NewFrontend/.htaccess Ignored 
Hidden /Applications/mamp/htdocs/NewFrontend/.travis.yml Ignored 
Hidden /Applications/mamp/htdocs/NewFrontend/application/.DS_Store Ignored 
Hidden /Applications/mamp/htdocs/NewFrontend/application/config/.DS_Store Ignored 
Hidden /Applications/mamp/htdocs/NewFrontend/application/libraries/tcpdf/tools/.htaccess Ignored 
Hidden /Applications/mamp/htdocs/NewFrontend/images/.DS_Store Ignored 
Hidden /Applications/mamp/htdocs/NewFrontend/lp/.htaccess Ignored 
Hidden /Applications/mamp/htdocs/NewFrontend/lp/m/.htaccess Ignored 


Grabbing README/INSTALL/CHANGELOG 

done 


Tutorial/Extended Documentation Parsing Stage 

done 

一般分析阶段

Reading file /Applications/mamp/htdocs/NewFrontend/application/cache/index.html -- File not parsed, not a php file 
Reading file /Applications/mamp/htdocs/NewFrontend/application/config/autoload.php -- Parsing file 
WARNING in autoload.php on line 115: File "/Applications/mamp/htdocs/NewFrontend/application/config/autoload.php" has no page-level DocBlock, use @package in the first DocBlock to create one 
Reading file /Applications/mamp/htdocs/NewFrontend/application/config/constants.php -- Parsing file 
WARNING in constants.php on line 40: File "/Applications/mamp/htdocs/NewFrontend/application/config/constants.php" has no page-level DocBlock, use @package in the first DocBlock to create one 
Reading file /Applications/mamp/htdocs/NewFrontend/application/config/database.php -- Parsing file 
WARNING in database.php on line 135: File "/Applications/mamp/htdocs/NewFrontend/application/config/database.php" has no page-level DocBlock, use @package in the first DocBlock to create one 
Reading file /Applications/mamp/htdocs/NewFrontend/application/config/development/config.php -- Parsing file 
WARNING in config.php on line 611: File "/Applications/mamp/htdocs/NewFrontend/application/config/development/config.php" has no page-level DocBlock, use @package in the first DocBlock to create one 
Reading file /Applications/mamp/htdocs/NewFrontend/application/config/doctypes.php -- Parsing file 

Answer 1

phpDoc将查找文件级别的docblock以在任何代码之前出现。由于第1行中的“if”在它之前没有docblock，因此会出现该错误。在“if”行之后，您确实拥有的docblock将与随后出现的任何代码元素相关联，无论是类，函数，甚至仅包含/ require行。

您可以“解决”该错误的唯一方法是在该顶部“if”行之前放置docblock。该docblock至少需要@package标记，否则，因为这看起来不是名称空间的代码。

像这样：

<?php 
/** 
* 
* Project 1 files 
* 
* @package  Project1 
* @subpackage projectControllers 
* @author  Abhishek Salian 
* @copyright Copyright (c) 2013, AS. 
* @link  http://localhost/project1/ 
* @since  Version 1.0 
*/ 

/** no direct access */ 
if (! defined('BASEPATH')) exit('No direct script access allowed'); 

// now more stuff... 

这可能需要有一个这样的文档块“/ **无法直接访问* /”，在IF行的前面，使分析器不扎“项目1文件”docblock到“IF”行本身。