我可以在方法声明之外使用<see cref =“”>

时间:2018-07-02 13:26:14

标签: c# comments documentation

我需要在函数内的注释中使用///<see cref="">,并且只有在方法声明中时才能使它起作用。

我要实现的目标是可能的吗?如果可以,怎么办?

所以本质上我需要这个:

///<summary>
///this is a summary where i can use the <see cref=""> with ease
///</summary>
internal virtual void OnClick()
{
    if (player.IsPlaying || player.IsBuffering)
    {
        //Some lengthly comment about code that I erased for simplicity
        //And I would like to add a <see cref=""> somewhere around here.
        player.Stop(false);
    }

        item.TogglePlayStop();
    }
}

如果将其放在方法中,则会得到XML Comment is not placed on a valid language element。外面工作正常。

我想这样做是因为我在注释中解释的内容与方法无关,仅与代码的一小部分有关。我正在处理遗留代码,不得不添加一些臭味。我不希望人们错误地删除它,并且我当然不希望人们在它上面浪费时间。一旦您看到整个图片就很简单,并且我只想添加一个链接,因此人们不必复制粘贴类名即可导航,他们只需单击我的注释(长7行)< / p>

0 个答案:

没有答案