代碼文檔中最常用/喜歡的語法（註釋）？

Question

我一直在使用Notepad ++編寫PHP多年，但今天我下載了Eclipse IDE。其功能之一是自動完成某些「語法模式」，如註釋。我見過很多不同的方式來實現註釋和文檔到php文件中，所以現在我開始想知道，我應該遵循Eclipse的語法。

這裏是我的意思是易如反掌：

你覺得呢？

馬爾蒂·萊恩

Answer 1

是PHPDoc的格式，使用評論的方式來自動文檔代碼。

http://www.phpdoc.org/

Answer 2

的Eclipse似乎撿phpDoc（可能是PHP項目中最常見的解決方案和一個我很樂意推薦）的元素，這是記錄了各種類，方法，方法參數的好方法等等，以及提供跟蹤待辦事項，標記功能/方法爲過時的方式等。

此外，您當然也可以使用phpdoc命令生成HTML，PDF，CHM格式等文檔line tool

你可以找到o請在phpDoc site上查看更多（並查看所需的語法）。

Answer 3

Eclipse會盡最大努力使用heredoc/phpdoc註釋，然後將其編譯到文檔中。嘗試編寫一個函數，然後在其上面添加一個/ **註釋，然後您會看到ecplise會自動在註釋中添加函數參數。

如果你看看Java API，那是從那種風格的評論中得到的那種文檔。

如果你不認爲你會把你的意見編譯成文檔，那麼不要被它束縛，代碼中的額外註釋總是有用的。但是，它是一個文檔標準，所以它不是一件壞事。我只傾向於使用這種評論方式，因爲我知道很多其他人都會關注。

Answer 4

正如其他人指出的那樣，對phpdoc使用這種評論可能非常有價值。但是我認爲它不僅僅是生成文檔，而且使編寫代碼更容易。一些IDE（至少Netbeans）使用phpdoc評論來提供比其他方式更好的自動完成功能。