美麗的代碼評論塊設計：畫廊，文章，首選項

我總是大量記錄我的代碼，以便其他人（和我在路上）能夠快速理解正在發生的事情。所以我經常想知道是否有任何畫廊或收集評論設計。任何鏈接或只是一般喜好？美麗的代碼評論塊設計：畫廊，文章，首選項

這是我經常使用的一對（在PHP中）。

在文件的頂部：

// ******************************* INFORMATION ***************************// 

// ***********************************************************************// 
// 
// ** NAME - A description of what the file does. 
// ** 
// ** @author name <[email protected]> 
// ** @date date 
// ** @access private 
// ** @param  
// ** @return if a class what object is returned 
//  
// ***********************************************************************// 

// ********************************** START ******************************//

用於標記一組功能：

// =======================================================================// 
// ! A description of what the following functions have in common   //   
// =======================================================================//

我一直有困難的時候，因爲「註釋塊」搜索關於該主題或「代碼評論」通常會在編寫博客評論系統時返回內容:)

來源

2011-06-18 websiteguru

這將是非常主觀的，IMO –

它可以是非常有趣的你：http://manual.phpdoc.org/HTMLframesConverter/default/ –

顯然。但是，問題不在於：「在那裏的任何畫廊或收集評論設計？」 – websiteguru

儘管這是@jcomeau_ictx建議的主觀方式，但存在phpDocumentor（或phpdoc或phpd OCU）。我強烈建議你看看它。您可以在http://manual.phpdoc.org/HTMLframesConverter/default/找到文檔。

它們的語法與你的語法略有不同。這與Javadoc很相似。

例如：

/** 
* Sample File 3, phpDocumentor Quickstart 
* 
* This file demonstrates the use of the @name tag 
* @author Greg Beaver <[email protected]> 
* @version 1.0 
* @package sample 
*/

有一些例子給你看的網站上。

如果您想查看其他開發人員在做什麼，還可以查看http://www.google.com/codesearch並搜索包含某些更可能有評論的單詞（例如function或class）的PHP文件。

來源

2011-06-18 18:51:47

我意識到這一點...我總是發現它非常醜陋，雖然:-p – websiteguru

@websiteguru - 再次，這是主觀的。我已經親自使用了這個和Javadoc多年。我幾乎願意說這是一個「標準」。如果您需要「圖庫」，請嘗試查看[http://www.google.com/codesearch]（http://www.google.com/codesearch）並查看其他人正在做什麼。 –

美麗的代碼評論塊設計：畫廊，文章，首選項

回答

相關問題