什麼是文件，類和構造函數的正確方法？

什麼是始終如一地寫只包含一個類的構造函數和類文件註釋塊最有用的/最標準/最令人驚訝的方式？什麼是文件，類和構造函數的正確方法？

註釋塊類，而不是構造
註釋塊構造函數，而不是類
註釋塊都構造函數和類 - >在這種情況下，應該在每個走什麼樣的細節？

然後文件本身？如果它只包含一個類，它是否需要註釋塊？應該去哪些細節？

我想嘗試儘可能地避免類，構造函數和文件註釋塊之間的重複。

2011-04-21 Rupert Madden-Abbott

*（相關）* [什麼是在PHP5評論的有效和可讀的方法]（http://stackoverflow.com/questions/5618592/what-are-the-valid-readable-approaches-to-commenting-in-php5/5618786） – Gordon 2011-04-21 09:55:06

句法「正確的方式」是由生成的結尾用戶文檔在工具完成解析之後即可看到。這在很大程度上是實現定義的文檔內容的質量由用戶在使用之前是否仍然需要閱讀源代碼來定義。 - 也是IDE自動完成友好的文檔語法的獎勵點。 – 2016-10-06 02:22:21

評論一切 - 文件（作者，版權，說明等），類（描述，代碼示例），方法和屬性。 Here就是一個很好的例子，phpDoc評論。

來源

2011-04-21 09:19:08 biakaveron

-1 ZF提供的文檔數量對於公共框架是可行的，但不一定適用於所有應用程序。我也會爭辯說，ctor和getter和setter的簡短描述是完全多餘的。 – Gordon 2011-04-21 09:24:19

如果你想重用你的代碼（或者別人會這麼做） - 像Zend那樣記錄它。 5分鐘現在將爲您節省大量時間 – biakaveron 2011-04-21 09:29:17

@biakaveron您是否打算說，特別是關於構造函數，設置函數和getter的簡短描述可以更輕鬆地重用代碼？如果是這樣，爲什麼？ – 2011-04-21 09:37:49

就個人而言，我只在構造函數，如果有什麼特殊的地方發表意見（如特殊的初始化）發表評論。

我不會說這是「最有用」的方式，但它保持代碼整潔，重複兩次相同的事情並不是真的需要（如果這是你的關注）。

來源

2011-04-21 09:20:45 Sword22

我個人認爲的類和方法的文檔是身邊最重要的文檔。當我編寫代碼時，當代碼完成向我顯示屬於某個方法的文檔時，我需要IDE的幫助。這樣我就可以輕鬆找到我需要的方法。

由於我試着類的顯式初始化到最低限度，我就不用戶構造意見。因此，我儘量避免使用構造函數本身。

方法或函數中的代碼應儘可能清晰，方法是使用聲明式變量名稱並儘可能小。只有當我做出意想不到的事情時，我纔會對它們進行評論。

來源

2011-04-21 09:38:11 pderaaij

什麼是文件，類和構造函數的正確方法？

回答

相關問題