2015-02-05 58 views
1

我試圖清理包含相當數量代碼的類。我也想記錄和文件。不幸的是,對我來說,所有這一切都在一個文件中造成眼睛的混亂。這是嚴重的,爲了快速發展,它創造了大量不必要的醒目文字來梳理。如何在Intellisense工具提示中使用<include>標記顯示包含的Xml文檔中的內容

<include>似乎有希望實現這一目標,同時保持智能感知功能。即包含的Xml文檔摘要將顯示在工具提示中,就像Xml文檔在方法上方聲明一樣。

也許我誤解了<include>,但我這樣做了,工具提示沒有包含在其他文件中的Xml文檔。

這裏是我有現在的設置:

/// <include file='xml_include_tag.xml' path='include/member[@name="Foo"]/*' /> 
private String Foo() 
{ 
    return "Foo"; 
} 

XML文件看起來是這樣的:

<include> 

    <member name="Foo"> 
     <summary> 
      Returns "Foo" 
     </summary> 
     <returns></returns> 
    </member> 

</include> 

我是正確使用本產品或者是這甚至不可能實現與提供工具集?

在此先感謝!

+0

這就是爲什麼我只使用'

'標籤並將所有內容放在其中的原因之一:P – Cameron 2015-02-05 17:33:19

+0

@Cameron同上。他們很好地組織信息,像異常信息,評論等可以是非常有用的。但每種方法10行xml?這有點多Lol如果包含這樣的工作方式,我們也可以在不同的方法之間共享文檔。 – 2015-02-05 17:44:30

回答

0

該文檔並不完全清楚,但似乎Visual Studio C#編輯器中的IntelliSense不支持此功能(至少在VS2013中)。太糟糕了,它似乎很有用。

相反,它似乎只適用於項目屬性(Build部分)中的「XML文檔文件」選項,該選項輸出預期的XML。

請注意,您的XML文件與XPath語句不完全匹配 - 您需要一個名爲<include>的根元素纏繞在​​元素上以便匹配。

+0

這很奇怪,因爲我包含了根標籤,但保存時會將其移除。然而,它在Xml文件中,但仍然沒有運氣。我也很害怕這個。它只適用於輸出文件,IntelliSense沒有任何內部功能。 – 2015-02-05 19:27:11

相關問題