無阻礙的XML評論

我已經創建了一個項目並開始編寫它的工作。 Sandcastle使用XML註釋來創建一個很好的幫助文件，但是XML註釋讓代碼幾乎不可讀。每個班級我現在寫開始了這樣的事：無阻礙的XML評論

/// <summary> 
/// Summary of Foo class 
/// </summary> 
public class Foo 
{ 
    ///<summary> 
    ///Summary of bar</summary> 
    public int bar; 
    ///<summary> 
    ///Summary of bat</summary> 
    public String bat; 

    ///<summary> 
    ///Summary of constructor</summary 
    ///<param name="a">description of a</param> 
    ///<param name="b">description of b</param> 
    public Foo(int a, int b) 
    .... 
}

有什麼辦法清理這些代碼了，同時留下了足夠的信息來創建一個漂亮的幫助文件？

來源

2013-05-15 Lukas Bystricky

您可以通過這裏來看看，如果你不確定... http://msdn.microsoft.com/en-us/library/b2s063f7.aspx

下面是他們的榜樣： http://msdn.microsoft.com/en-us/library/aa288481(v=vs.71).aspx

但是，這究竟實話它應該如何看。除非我對它做出改變，否則我通常會盡量減少。但是，如果新開發人員加入您的項目，那麼完整的XML文檔可能是天賜之物。

只是通過它戰鬥，並希望學會愛它？

來源

2013-05-15 13:24:47 Wrightboy

這太糟糕了，因爲我的一些方法有超過10個參數，所以你可以想象這是怎麼回事。基本上整個屏幕接受了有人閱讀代碼所不需要的評論。 –

這就是爲什麼它們都是可摺疊的。寫下來，崩潰，繼續前進。如果您需要進行更改，請展開並執行。我絕不會把所有的評論都公開，文件會像你說的「不可讀」一樣。 ctrl-M-O（全部摺疊）是你的朋友！說實話，當我開始使用它時，我感覺到了同樣的方式，讓所有的東西都感到臃腫。現在，如果沒有XML並且sandcastle可以很好地工作來生成文檔，那麼我什麼都不會留下。 – Wrightboy

我期待着IDE將爲我們格式化這一切的日子（當然，我們不會主動編輯它）。與此同時，我真的讀過它，我沒有真正注意到格式。 –

有針對^*擴展：

Hide/Show Comments

^{* _{我還沒試過此我自己，但看起來它可能會幫助你。}}

來源

2013-05-15 13:51:55

include tag允許您將大部分文檔放在單獨的文件中。通常，這用於在虛擬或接口成員的各種實現中重用公共文檔，但也可以用於簡單分離文檔。

來源

2013-05-25 15:05:50

無阻礙的XML評論

回答

相關問題