PHP評論格式：自動生成或用戶創建？

Question

我一直在php中看到這些標題註釋，並且經常想知道是否使用了某些軟件來設置它們？我似乎記得JavaDoc或什麼？但我不確定這是否是自動生成的？或者這只是某種類型的文檔標準？

下面的例子是從CodeIgniter：

/** 
* CodeIgniter 
* 
* An open source application development framework for PHP 4.3.2 or newer 
* 
* @package  CodeIgniter 
* @author  ExpressionEngine Dev Team 
* @copyright Copyright (c) 2008, EllisLab, Inc. 
* @license  http://codeigniter.com/user_guide/license.html 
* @link  http://codeigniter.com 
* @since  Version 1.0 
* @filesource 
*/ 

我真的想提高我的評論，我覺得這將是我的項目的最佳形式。

Answer 1

這是phpDoc這是由一些框架使用反射動態理解和使用類（由代碼本身）。

IDEs也將它用於自動完成，顯示函數參數等。好東西知道你的IDE是否爲你使用的框架提供了這些功能，但不是你編寫的代碼。

PHP's Reflection API

Zend Framework Extension (including DocBlocks)

CodeIgniter's Comment Guide (Using DocBlock '...so they can be picked up by IDEs')

DocBlock Description on phpdoc.org (linked from CI's Style Guide)

Answer 2

這是JavaDoc，它可能是由IDE自動生成的。

Answer 3

一些IDE的可以把它自動的，但人們往往只是輸入。

對於PHP是PHP Documentor，你可以看到一個quickstart guide here。

這將掃描您的源代碼並根據您對您的文件，類和功能的評論創建文檔。

Answer 4

這些註釋遵循phpdoc的標準，可用於爲您的代碼自動生成文檔。你可以看到這樣一個文檔here的例子。

雖然有些IDE支持簡化寫入，但實際內容是由程序員手寫的。