我不知道這些XML參考是如何工作的,我只是不明白爲什麼他們工作或爲什麼他們不工作,我什麼也沒有發現。Delphi xml註釋中的<see>標記實際上在什麼情況下工作?
下面是一個例子:
type
TOuterClass= class
strict private
type
TLogger = class
public
/// <summary>adds a log entry</summary>
/// <param name="Msg">text to log</param>
procedure Log(const Msg: string);
end;
strict private
FLogger: TLogger;
public
/// <summary>adds a log entry</summary>
/// <param name="Msg">text to log</param>
/// <remarks>just calls <see cref="TOuterClass.TLogger.Log" />
/// </remarks>
procedure Log(const Msg: string);
property Logger: TLogger read FLogger;
end;
在TOuterClass.Log的評論的鏈接不起作用。德爾福XE5只是想它,然後放棄。
另一個很簡單的例子:
Unit MyUnit
type
/// <summary>MyType Comment</summary>
TMyType = reference to procedure;
/// <param name="MyTypeParam"><see cref="MyUnit.TMyType" /></param>
procedure MyProcedure(MyTypeParam: TMyType);
同樣,這個鏈接不起作用。有趣的是:如果你只是註釋掉了xml註釋,那麼Delphi會自動創建相同的鏈接文本(「MyUnit.TMyType」)並且它可以工作!這真讓我困惑。
究竟可以將這些鏈接鏈接到,該公約必須跟着我得到它的工作,什麼他們不能鏈接到?
的official documentation很短於這個:
<see> Reference to a specific type, symbol, or identifier
如果是任何重要:我用Delphi XE5,但我將不勝感激這是如何工作的德爾福的任何版本的提示。我甚至可以欣賞實際工作的鏈接的示例(請包括您的Delphi版本),也許這將有助於揭示它背後的機制。
編輯2014年8月25日:
我開始認爲這些鏈接鏈接到實際的HTML文檔文件,這在我的情況下,不存在,因爲我沒有爲定義的目錄他們。我只是在使用XML註釋來獲取Delphi IDE中的提示。任何人都可以確認嗎?
這可能是它只支持本地引用。試試看看這裏介紹的DocInsight人員:他們似乎都知道這應該如何工作。 –
這是一個很好的觀點,但我怎樣才能讓DocInsight人蔘與其中? – RSE
平安[寶泉佐(http://stackoverflow.com/users/214400/baoquan-zuo)(:@BaoquanZuo(編輯:嗯:那@沒有工作) –