Question

我倾向于在1种方法中写一些评论。偶尔我指的是另一个类中的另一个方法或属性。它类似于：

//如果您取消注释下一行，请确保选中“MyClass.SomeMethod”。

[更新]
试图希望减少代码的臭味评论。也许它可能会像（谢谢@Weston）：

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

也许类似的东西可以写在方法中？ @weston的答案对我有所帮助。 [/更新]

我正在寻找可以点击它的东西。是否有任何现有的扩展/插件/添加可以做这样的事情？

Answer 1

如果您有resharper，那么导航到定义的documentation comment solution + F12可以正常工作。

    /// <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){

Subtract或Multiply上的光标，然后F12将带您到那里。请注意，我已尝试关闭resharper并且无法正常工作。

此外，resharper将在这些评论中应用重命名重构。

Answer 2

无论如何，这是一个糟糕的主意，如果你必须在一个地方包含可能破坏/改变功能的其他代码区域的注释，那么你的代码可能需要重新思考。

除此之外，我建议您查看visual studio扩展库，可能会有适合您需求的扩展程序。

如果没有查阅扩展视觉工作室的指南，那么这样做的扩展可能不会太难以自己组合。

是否可以添加引用或链接到方法或属性？

2 个答案: