2013-04-03 31 views
0

我傾向於在1種方法中寫出相當多的評論。偶爾,我指的是另一個類中的另一種方法或屬性。它類似於:是否可以添加對方法或屬性的引用或鏈接?

//如果取消註釋下一行,請確保檢查'MyClass.SomeMethod'。

[更新]
在試圖希望得到較少的代碼臭評論。也許它可能會像(謝謝@韋斯頓):

/// <summary> 
/// Adds two numbers 
/// See method Subtract for the opposite of add. 
/// See also Multiply 
/// </summary> 

也許類似的東西可以寫在一個方法? @weston的答案可以進一步幫助我。 [/更新]

我在尋找什麼令它點擊。 是否有任何現有的擴展/插件/添加可以做到這一點?

+0

您是否正在進行動態呼叫? – vittore

+0

試試Resharper? – Lanorkin

+2

你可以選擇文本,然後按Ctrl +逗號獲得「導航到」與預先輸入的值...任何好? –

回答

1

如果你有ReSharper的那麼documentation comment solution + F12導航到定義確實工作。在SubtractMultiply

/// <summary>Adds two numbers 
    /// <para>See <see cref="Subtract"/> for the opposite of add.</para> 
    /// See also <seealso cref="Multiply"/> 
    /// </summary> 
    public int Add(int x, int y){ 

光標然後F12會帶你去。請注意,我已嘗試使用resharper,它不起作用。

更重要的是,resharper將在這些評論中應用重命名重構。

+0

這對我來說足夠了,thx – TweeZz

1

這是非常不好的想法,無論如何,如果你有包括有關,如果你做的東西在一個地方,然後你的代碼可能需要重新思考,可能打破/更改功能代碼的其他領域筆記。

除此之外,我建議在visual studio擴展庫中尋找,可能會有一個適合您的需求的擴展。

如果沒有找到擴展visual studio的指南,那麼這樣做的擴展可能不會太難以將自己放在一起。

+1

重申你的最後一行:掃描每一個評論的每一個單詞,看它*是否可能只是一個成員名稱/類型名稱 - 對於大型項目,我可以看不到結局。 –

+0

@MarcGravell真的,我可以想象這會導致問題,制定一些策略,特別是將註釋行標記爲包含鏈接可以完成,但我同意,這樣做完全是瘋了。我認爲首先需要這樣的功能或創建這樣的評論是錯誤的,但如果需要的話,它會提供某種形式的解決方案。 – Clint

+0

這是無關緊要的原因。也許我會寫一些評論來幫助新人或其他人。你的回答並不回答我的問題。 – TweeZz

相關問題