我可以在評論中添加鏈接到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