我可以在评论中添加链接到Visual Studio中的代码块吗?我可以在评论中添加链接到Visual Studio中的代码块吗?
例如:
// block 1
class class1
{
}
// block 2
class class2
{
// review [___class1]
}
[___class1]是类class1
预先感谢的链接。
我可以在评论中添加链接到Visual Studio中的代码块吗?我可以在评论中添加链接到Visual Studio中的代码块吗?
例如:
// block 1
class class1
{
}
// block 2
class class2
{
// review [___class1]
}
[___class1]是类class1
预先感谢的链接。
您可以在Visual Studio中使用bookmark代码,但该代码存储在用户选项文件中,通常不会检入源代码管理。我不知道链接到其他代码部分的代码部分的方法。
你最好的选择可能是使用文档的意见和<see>
标签:
/// <see cref="Fully.Qualified.Type.Name"/>
但是那将仅限于完全合格的位置,即类型,方法,字段和属性。一个特定的块(例如,方法中的if
语句)是正确的,它只会将该方法的任何文档的文档链接到另一个文档部分,然后仅当您使用类似Sandcastle的工具生成文档时。其他
有一两件事你可以考虑,这是一个非常糟糕的黑客,是用文件的超链接,就像这样:
// file://c:/code/file.cs
有警告:
只是对文件链接的第二个警告(第三个建议)的评论,你可以简单地用双引号将链接包起来,任何数量的空格都可以工作。 – Adam 2014-02-12 12:29:43
这取决于你想要什么 - 你可以添加一个URL,VS会在代码视图中自动将它变成一个链接。
生成文档时是否将其转换为链接取决于您使用的工具。
编辑:好的,这可能是我错过了你的意思。这并不十分清楚你到底想要做什么。
如果你想提供一些示例代码,你可以使用example
标签:
/// <example>
/// Foo f = new Foo();
/// </example>
那是你的意思?
你不能链接到一个特定的代码块,但你可以链接到成员或类型,例如:
/// <remarks>
/// You can use the <see cref="DoSomething" /> method to do something similar.
/// </remarks>
您可以随时把链接的意见(因为它们仅仅是文本,就像文件的其余部分)。
它取决于IDE如何显示 - Visual Studio将使其成为可点击的超链接。
编辑:
如果你想从意见参考你的代码的其他部分,有在这个Visual Studio中没有电流支持。使用引用标记(例如see
)可以获得最接近code documentation的评论,但这仍然不会在IDE中生成超链接。
这是未来Visual Studio新特性的一个很好的问题,它可以帮助我们理解和访问代码,例如我用我的代码对包含伪代码的代码或每个代码段的算法解释做出评论的代码会在现实生活中发挥作用,并且将每一步链接到代码的相应部分将会非常好。 – 2016-10-17 08:25:19