我有一个property
可以null
。我想在 中记录这一点summary
,这是我的问题。
/// <summary>
/// Can be <see cref="null"/>.
/// </summary>
public object FooProperty;
ReSharper
说,有一个Syntax Error
,但突出显示按预期工作!
/// <summary>
/// Can be <see><cref>null</cref></see>.
/// </summary>
public object FooProperty;
将其格式化为 时nested
,高亮不再起作用。
/// <summary>
/// Can be <see langword="null"/>.
/// </summary>
public object FooProperty;
langword
正在工作,但没有intelliSense
in VisualStudio
。
有人可以告诉我记录这些的正确方法是什么keywords
,IntelliSense
支持会很好!
该langword是要走的路。您是对的,对此没有 Intellisense 支持。可能是因为它不是官方推荐的 XML 注释标签属性。但是可以根据您的评论生成文档的工具,例如 Sandcastle Help File Builder 或 VSdocman(免责声明,我是 VSdocman 的开发人员)将识别此语法并生成特殊文本。例如,VSdocman 生成:
null 引用(在 Visual Basic 中为Nothing)
这同样适用于其他保留字,例如 true、abstract 等。
虽然 Intellisense 不会帮助您,但 VSdocman 有一个 WYSIWYG 评论编辑器,可以帮助您处理更复杂的评论。
还有一个注意事项<see cref="null"/>
。这将创建一个指向名为null的类、方法或属性的链接。这在 C# 中无法直接实现,您需要在作为保留字的名称前加上 @:
/// <summary>
/// <see cref="@null"/>
/// </summary>
public class MyClass
{
public void @null() {}
}
但这在 VB .NET 中完全有效:
''' <summary>
''' <see cref="null"/>
''' </summary>
Public Class MyClass
ReadOnly Property null As String
End Class
本文收集自互联网,转载请注明来源。
如有侵权,请联系 [email protected] 删除。
我来说两句