方法/属性的属性和XML文档说明

40

当我想要为一个方法/属性添加一个属性和XML文档注释时,应该在方法/属性上方以什么正确的顺序编写它们?

这听起来很琐碎,但是...

如果我使用:

/// <summary>
/// Something here
/// </summary>
[MyAttribute]
public void MyMethod() {}
Build已成功且ReSharper感到“高兴”,但我在IntelliSense中看不到 MyClass.MyMethod 的文档。

当我使用:


当我使用:

[MyAttribute]
/// <summary>
/// Something here
/// </summary>
public void MyMethod() {}

构建成功,但ReSharper有一个警告(XML注释未放置在有效的语言元素上),并且我仍然在IntelliSense中看不到MyClass.MyMethod的文档。

我在互联网上搜索只看到使用属性而没有文档或者文档没有属性的例子。

真的没有一种方法可以为同一个方法/属性同时添加属性和XML文档吗?

信息:WPF应用程序,.NET 4.0,C#。


Visual Studio(或者可能是ReSharper)?只需要在方法(或属性)上方键入三个斜杠///,它就会自动生成。 - spender
忘记添加 - VS2010。我试过在属性上方编写(如上面的第一种情况),但 IntelliSense 中没有生成文档。同一类中没有属性的其他方法/属性按预期显示文档。 :( - XAMeLi
1
当 IntelliSense 中两种情况都没有显示时,那么你首先需要解决一个无关的问题。 - H H
@Henk - 我很害怕这个。您有任何关于从哪里开始查找的指针吗? - XAMeLi
进行重建,检查错误和警告。您是否在同一程序集中检查Intellisense? - H H
1个回答

36

使用第一种情况,

/// <summary>
/// Something here
/// </summary>
[MyAttribute]
public void MyMethod() {}

Resharper喜欢它并且应该在Intellisense中给你一些东西。如果没有出现,那么就有另一个问题要解决。


1
需要重新启动我的电脑...浪费了我人生中最宝贵的两个小时...感谢你的帮助。 - XAMeLi
1
感谢您为我节省了更多的编码和搜索时间 +1 - Simua

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接