Delphi HelpInsight CREF语法

时间:2019-03-21 14:21:38

标签: xml-documentation

我在delphi文档中的cref语法有问题。当我仅使用IDE时,链接有效并打开另一个主题。

/// <summary>
///  Opens a file FileName in Mode. Mode constants are in unit Sys_Files. Opened file must be closed with <see cref="R_FunctionsDoc|TScriptFunctionsDocumentation.FileClose">FileClose</see>.
/// </summary>

但是当我要使用--doc标志编译项目时,会收到警告

Warning: W1206 XML comment on 'FileOpen' has cref attribute 'R_FunctionsDoc|TScriptFunctionsDocumentation.FileClose' that could not be resolved

并且在xml输出中只有

<devnotes>
<!-- Badly formed XML comment ignored for member 'FileClose' -->
</devnotes>

另一方面,当我替换|与。没有编译器警告,但是在IDE帮助中没有遵循该链接。在输出xml中,有

<devnotes>
  <summary>
    Opens a file FileName in Mode. Mode constants are in unit Sys_Files. Opened file must be closed with <see cref="M:R_FunctionsDoc.TScriptFunctionsDocumentation.FileClose(System.Integer)">FileClose</see>.
  </summary>
</devnotes>

既有解决方案,又可以同时存在?我需要xml输出用于下一步处理,并且在IDE中的工作帮助也很棒。

0 个答案:

没有答案