Question

我在评论块中使用了@remarks和@ingroup，但是当我运行Atomineer时，它会一直将它们标记为删除，我不知道如何防止它这样做。我看了修改.XML配置文件中的规则，但我显然遗漏了一些东西。

使用Atomineer处理之前的示例：

//-------------------------------------------------------------------------------------
/// @copydoc interface_Result
///          
/// @ingroup platform_implementation module_core
//-------------------------------------------------------------------------------------

使用Atomineer处理后的示例：

//------------------------------------------------------------------------------------
/// @copydoc interface_Result.
///
/// ### ingroup platform_implementation module_core.
//------------------------------------------------------------------------------------

文档说：“设置您的Doxygen或DocXML模板以指示新评论格式中的'合法'条目，以及如何在新评论块中对它们进行排序。旧条目中具有相同标记的任何条目新格式（例如param - ＆gt; param）将自动“转换”（以新样式重新格式化）。任何被AtomineerUtils视为“合法”的条目都将被标记为“已删除”并带有###前缀。 “

任何指针或想法都会受到赞赏吗？我真的需要它来退出这个。

谢谢！

Answer 1

（我是Atomineer Pro Documentation的作者）

在Visual Studio中，

转到工具＆gt; Atomineer选项......
切换到“高级自定义”标签
单击阻止模板 - Doxygen 按钮。

将打开一个编辑器（记事本），其中包含供您自定义的模板。

模板是基于XML的，它们指示Atomineer：

哪些条目合法（必填或可选）。任何未提及的条目都被视为“非法”，并在您找到后删除。
生成/更新评论时应对条目进行排序的顺序
在评论区块中添加其他空格（空白行）的位置
其他一些事项，例如是否应为每个条目启用/禁用标点符号更正等

Atomineer可以记录每种不同类型的代码元素的模板，因此您可以很好地控制文档的每个部分的外观，但它确实意味着您必须将新元素复制并粘贴到每个模板。

例如，以下是Doxygen方法注释的默认模板：

    <method>
        <prototype _punctuate="false" />
        <_ />
        <summary />
        <_ />
        <author _punctuate="false">%user%</author>
        <date _punctuate="false">%date%</date>
        <_ />
        <exception />
        <_ />
        <param />
        <_ />
        <returns />
        <_ />
        <sa _punctuate="false" _optional="true" />
    </method>

此中的每个XML元素（行）描述了注释中的一个条目。例如XML标记<param/>对应于@param条目将放置在最终注释块中的位置。特殊元素<_/>用于指示应插入空白行的位置。（原型是一个特殊的doxygen，告诉它在哪里插入原型/声明@fn，@ class等）

要允许@ingroup和@remarks插入Atomineer评论，只需在您希望它出现在评论中的位置添加条目，如下所示：

    <method>
        <prototype _punctuate="false" />
        <ingroup _optional="true" /> 
        <_ />
        <summary />
        <_ />
        <remarks _optional="true" />
        <_ />
        <author _punctuate="false">%user%</author>
        ...
    </method>

您将看到我添加的示例元素中包含属性_optional="true"。如果没有这个，Atomineer会将条目添加到每个评论（必填项）。如果它设置为true，那么Atomineer将不会添加条目，但如果您自己键入，Atomineer将确保在您更新doc-comment时保留它

我为这是多么复杂而道歉，但它是一个灵活的系统，允许每个人得到他们想要的东西，虽然有时需要几分钟的设置。每当我有时间，我都会编写改进的配置工具和教程，以简化此过程。但是，一旦你配置它，你应该有许多快乐的岁月; - ）

有关于模板的更多文档以及您可以在其中执行的其他操作here。

如果您还有其他问题，请随时在支持电子邮件中添加一行，该电子邮件位于Atomineer网站每个页面的底部。我总是很乐意提供帮助。

修改Atomineer中的规则

1 个答案: