【问题标题】:XMLDoc for Delphi unit nameDelphi 单元名称的 XMLDoc
【发布时间】:2020-03-10 07:27:55
【问题描述】:

是否可以使用<summary> XMLDoc 标签在 Delphi 中记录单元用途?怎么样?

我在unit之前都试过把总结:

/// <summary> Unit purpose: test </summary>
unit Test;

之后:

unit Test;
/// <summary> Unit purpose: test </summary>

这两种方法都没有任何效果。通过将鼠标悬停在另一个单元中的单元名称上进行检查。同时悬停适用于同一单位的其他标识符

【问题讨论】:

    标签: delphi xml-documentation delphi-10.3-rio


    【解决方案1】:

    根据 Embarcadero 的文档:

    XML Documentation Comments

    您可以在 XML DOC cmets 中使用以下元素:

    &lt;summary&gt;

    目标函数或类

    的摘要

    所以不,您似乎不能将&lt;summary&gt; 应用于整个单元。

    【讨论】:

    • 确实,它也适用于属性和非类的类型,如记录、枚举、简单类型(如type MyInt = type Integer)等,因此文档中的这句话不太准确.但是,如果 Serhii 试图将 XML 注释放在一个单元之前并且它不起作用,这很可能意味着这个问题的答案是“否”(至少在 OP 的 Delphi 版本中)。所以说真的,这个 Q 更像是针对 Embarcadero 的 Delphi 功能请求! :)
    猜你喜欢
    • 1970-01-01
    • 2017-01-29
    • 2020-01-30
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2019-09-08
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多