我想我可以在xml评论中使用cref。
我还发现了一个使用nameof运算符的狡猾方式。
string fakeString = nameof( NewForm.HandleCommandLineArgments ); // use go to definition to get to NewForm.HandleCommandLineArgments
还有其他想法吗?
更新:我意识到如何去定义,理想情况下我不必添加“string fakeString”。我认为cref有点令人失望,因为我认为它只能在方法顶部的xml注释中,但你可以将它们放在任何地方。
我要去:
/// <see cref="NewForm.HandleCommandLineArgments">
PipeClient.SendSimpleStringMessage( "scriptcode", "[Arguments]" + commandLineArguments );
在Visual Studio 2017中,您可以使用Ctrl + T(或任何分配给Edit/Go To All
的快捷方式)转到任何类型。即使在早期的Visual Studio版本中,ReSharper也具有类似的功能。
更多不应该是必要的;和你的fakeString
这样的变量实际上是代码气味(甚至可能因“未使用的变量”诊断而导致构建/维护问题)。
如果它与方法有关,那么通过<see cref="..."/>
和/或<seealso cref="..."/>
在XML Doc中包含链接也是完全可以接受的。