Visual studio VisualStudio |带有关键字的摘要';空';
我有一个Visual studio VisualStudio |带有关键字的摘要';空';,visual-studio,documentation,resharper,summary,Visual Studio,Documentation,Resharper,Summary,我有一个属性,它可以是null。我想在摘要中记录这一点,这是我的问题 cref 将其格式化为嵌套时,Highlighting将不再工作 语言文字 // ///可以。 /// 公共物品和财产; langword正在工作,但是VisualStudio中没有intelliSense 有人能告诉我记录这些关键字的正确方法是什么吗IntelliSense支持会很好 解决方法 语言是一条路要走。你是对的,没有智能感知的支持。这可能是因为它不是属性。但是可以根据您的评论生成文档的工具,例如Sandc
属性
,它可以是null
。我想在摘要中记录这一点,这是我的问题
cref
将其格式化为嵌套时,Highlighting将不再工作
语言文字
//
///可以。
///
公共物品和财产;
langword
正在工作,但是VisualStudio
中没有intelliSense
有人能告诉我记录这些关键字的正确方法是什么吗IntelliSense
支持会很好
解决方法
语言是一条路要走。你是对的,没有智能感知的支持。这可能是因为它不是属性。但是可以根据您的评论生成文档的工具,例如Sandcastle Help File Builder或VSdocman(免责声明,我是VSdocman的开发人员)将识别此语法并生成特殊文本。例如,VSdocman生成:
空引用(在Visual Basic中为空)
这同样适用于真实、抽象等
虽然Intellisense不会帮助您,但VSdocman有一个WYSIWYG注释编辑器,可以帮助您处理更复杂的注释
还有一个注意事项。这将创建一个指向名为null的类、方法或属性的链接。这在C#中是不可能直接实现的,在C#中,您需要在保留字的名称前面加上@:
/// <summary>
/// <see cref="@null"/>
/// </summary>
public class MyClass
{
public void @null() {}
}
//
///
///
公共类MyClass
{
public void@null(){}
}
但这在VB.NET中完全有效:
''' <summary>
''' <see cref="null"/>
''' </summary>
Public Class MyClass
ReadOnly Property null As String
End Class
“”
'''
'''
公共类MyClass
只读属性null为字符串
末级
啊,好的,谢谢!你知道我是否可以在“摘要”区域添加一个新的代码片段?
/// <summary>
/// Can be <see langword="null"/>.
/// </summary>
public object FooProperty;
/// <summary>
/// <see cref="@null"/>
/// </summary>
public class MyClass
{
public void @null() {}
}
''' <summary>
''' <see cref="null"/>
''' </summary>
Public Class MyClass
ReadOnly Property null As String
End Class