.Net XML文檔標準

我已看過建議的相關問題，但它們都不是我正在尋找的。作爲一名新開發人員，我正在努力遵循最佳實踐，並且文檔很大。我一直在嘗試在我的代碼中創建XML文檔。我發現了GhostDoc插件可以幫助加快速度。.Net XML文檔標準

雖然我的問題是;對於應包含在XML中的內容，是否有一個通常除外的標準？默認情況下，我在適用時使用<Summary><Param><Returns>。有其他人嗎？我應該包括作者嗎？怎麼樣？ <Patrick></Patrick>？ <Remarks>是值得的時間？

我將不勝感激這方面的任何指導。謝謝！

來源

2009-02-11 Refracted Paladin

我最近才發現this guide to XML documentation。這是真的方便。這不是最佳實踐指南，但它很好地覆蓋了不經常使用並因此被遺忘的標籤。

來源

2009-02-11 18:52:29

此鏈接已死亡。 – 2010-06-07 20:50:01

我絕對認爲<remarks>標籤是值得的，因爲它允許您詳細說明摘要，更多的知識總是一件好事。

我也認爲<typeparamref>對泛型類很重要。

在每個元素中，還應該使用<see>標記，以便您可以將文檔鏈接在一起。

除了標準標籤之外，我還添加了<author>以顯示類/方法/屬性/ etc等的原創作者以及<created>標籤，以指示何時創建該成員。在團隊環境中，你可能會想要的東西更強大的，就像這樣：

<revisions> 
    <revision> 
    <author>Nicholas Paldino</author> 
    <revised>2009-02-01</revised> 
    </revision> 
    <revision> 
    <author>Mr_Mom</author> 
    <revised>2009-02-11</revised> 
    </revision> 
</revisions>

來源

2009-02-11 18:32:59 casperOne

@casperOne：我想我會找到所有這些阻礙。這就是源代碼控制的作用......它更可能是一致和準確的，並且不會混淆代碼。 – 2009-02-12 19:11:06

.Net XML文檔標準

回答

相關問題