AtomineerUtils使用说明
介绍
AtomineerUtils 是国外的一款用于生成源代码注释的一款 VS 插件工具.
这款插件，支持 C、C++、C++/CLI、C#、Java 语言等，由此可以看出其强大，注释的风格可以灵活配置。
安装方法
软件是付费软件, 具体使用版本见附件 AtomineerUtils936 也可以在参考链接给出的网页内找到 使用方法.
具体安装方法可以看压缩包内附件文档,
- 正常安装相应文件夹内的VS插件,本人使用的是 VS2015 插件
- 第一次请务必断网进入VS，在插件里面把本工具的自动更新关闭掉，更新到最新版本将直接无法使用破解版本(如果刚好试用到期也不就不能用了)。
VS 2015之下的版本(未测试是否可用):
安装路径自己选的，然后找到：你的安装路径/visual studio 20**/Addins/AtomineerUtils/
替换掉里面的Atomineer.Utils.dll就好了
VS 2015版本:
替换位置: %LocalAppData%/Microsoft/VisualStudio/14.0/Extensions/(随机的名称)/
VS 2017版本:
替换位置: %LocalAppData%/Microsoft/VisualStudio/15.0_** (随机的名称) /Extensions/******(随机的名称)/
- 在相应文件夹内找到文件, 使用附件文件夹内的 同名文件替换掉里面的AtomineerProDocumentation.dll就好了
可以在VS 的拓展目录C:UsersChenAppDataLocalMicrosoftVisualStudio14.0Extensions 下搜索文件名可以快速找到
例如个人最终的路径为
C:UsersChenAppDataLocalMicrosoftVisualStudio14.0Extensionsg2iuajz1.bzoAtomineerProDocumentation.dll
PS:如果使用过程中出现路径错误的情况，菜单栏->工具->Atomineer...Trial->...options 进去点下确定出来就好了。
或者进入安装路径找到AtomineerUtilsWizard.exe，通过一下配置向导
使用方法说明
由于插件没有中文, 但是并不难理解,
使用的详细方法可以分为以下几步
1. VS 进入设置方法
工具->AtomineerProDocumentation Trail -> Atominee Option
进入方法
2. 初始设定
建议点击 quick 选择设置方案,根据自己感觉比较好看的方式设定即可, 因为后续需求, 这里选择的方案是 doxygen 的方式, 后续可以根据注释生成项目文档
仅供参考
初始设定
3. 注释模板路径
在通用设置界面, 选择注释模板文件的搜索路径, 会先从给出的路径进行搜索,如果存在会优先使用,如果找不到就会使用程序默认的方式生成注释, 附件详细配置文档 给出了自己的一份配置文件, 比较满意 如果自己感觉不舒服可以自己调整
注释模板
在通用设置的上半部分还可以设置右键显示的快捷菜单和菜单栏二级菜单显示的内容
4. 注释规则
可以根据不同的规则生成不同的注释, 这里使用较少, 暂时不了解怎么使用的,
不同规则
详细配置文档
详细配置文档定义了相应的行 执行相应的内容 在执行生成注释的时候会根据xml 配置文件以及在软件中的设置自动生成相关内容 详细配置文档
详细配置文档 DoxygenTemplates.xml
<DoxygenTemplates>
<!--
Templates for Doxygen/JavaDoc/Qt Comment blocks
===============================================
These control which entries are added to the doc-comment for each type of code element,
and their order.
Full documentation can be found in the Atomineer user manual.
-->
<!-- Global settings for the entry types.
These control the style and formatting of the individual types of entries defined in the templates below.
Each element here should match one of the entries in your template blocks, and should either match the
entry names Atomineer supports (e.g. "summary") or a custom entry type. If you wish to use a different
name in your entries than Atomineer (e.g. you prefer "brief" to "summary", then use the <summary> element
and set its _tagName attribute to "brief". You can also add a comma-separated list of _aliases to allow
for conversions from legacy comments.
Primary settings (see the user manual for more details) are:
_optional true indicates this entry is not to be added by Atomineer, but shuld be preserved
false indicates that this entry type is required, so Atomineer should automtaically add it
_punctuate true/false to control automatic punctuation insertion
_wordwrap true/false to control whether word-wrapping is applied to the description
_copyFromBase true/fase to control whether this type of entry can be copied from base-class documentation
_tagName The entry tag you want to use in your documentation, e.g. for Atomineer's "summary" you might
prefer to use the tag "description"
_aliases A comma-separated list of other tags that should be considered equivalent (to convert legacy comments)
-->
<!-- 条目类型的全局设置。=""
它们控制下面模板中定义的各种条目类型的样式和格式。=""
这里的每个元素都应该匹配模板块中的一个条目，并且应该匹配=""
条目名称Atomineer支持（例如“摘要”）或自定义条目类型。如果你想使用不同的=""
您的条目中的名称不是Atomineer（例如，您更喜欢“简要”到“摘要”，然后使用="" 元素
并将其_tagName属性设置为“brief”。您还可以添加逗号分隔的_aliases列表以允许
来自遗留评论的转换。
主要设置（有关详细信息，请参阅用户手册）包括：
_optional true表示Atomineer不会添加此条目，但会保留该条目
false表示此条目类型是必需的，因此Atomineer应自动添加它
_punctuate true / false控制自动标点符号插入
_wordwrap true / false控制是否将自动换行应用于描述
_copyFromBase true / fase控制是否可以从基类文档中复制此类条目
_tagName您要在文档中使用的条目标记，例如对于Atomineer的“总结”你可能会
更喜欢使用标签“description”
_aliases以逗号分隔的其他标记列表，应视为等效（转换旧版注释）
-->
<!-- prototye is a template placeholder for the code element type (fn,method,class,interface,etc) -->
<EntrySettings>
<prototype _punctuate="false" />
<author _punctuate="false" _optional="true" />
<copyright _punctuate="false" _optional="true" _aliases="copyright,Copyright,Copy,copy"/>
<date _punctuate="false" _optional="true" />
<remarks _optional="true" _aliases="remark" />
<summary _punctuate="false" _tagName="brief" _aliases="summary,desc,description,details,purpose,short" />
<exception _tagName="exception" _aliases="throw,throws" />
<param _punctuate="false" _tagName="param" _aliases="parameter" />
<typeparam _tagName="tparam" _aliases="typeparam" />
<returns _punctuate="false" _tagName="returns" _aliases="return,retval,result,value" />
<seealso _punctuate="false" _optional="true" _tagName="sa" _aliases="see,seealso" />
<example _punctuate="false" _optional="true" _tagName="example" />
<inheritdoc _punctuate="false" _optional="true" _tagName="inheritdoc" />
</EntrySettings>`
<!-- Special header and footer pair for .h and .hpp files, which will automatically add an
include-once mechanism to the file.-->
<!-- .h 文件 自动添加 #If endif-->
<!--<file _filetypes=".h .hpp" _addfooter="true" _separators="false">
<prototype>%projectpathname%</prototype>
<_ />
<summary />
<changelog>%date% %user% Created</changelog>
#ifndef __%leafname%_H__
#define __%leafname%_H__
</file>
<filefooter filetypes=".h.hpp" _separators="false">
End of %projectpathname%
#endif // __%leafname%_H__
</filefooter>-->
<!-- 文件头 comment 格式-->
<file>
<prototype>%projectpathname%</prototype>
<copyright> Copyright (c) 2019 IRIS_Chen IRIS Lab </copyright>
<_ />
<summary />
<changelog>%date% %user% Created</changelog>
</file>
<file-vb _separators="false">
<prototype>%projectpathname%</prototype>
<_ />
<summary />
</file-vb>
<!-- Free-form text example
<file>
// project: %project%
// file: %projectpathname%
//
// summary: %fileDescription%
//
// %copyright%
//
// Date Developer Change
// %date% %user% Created
</file>
-->
<!-- Default plain-text Atomineer file footer. These follow the same form as the file headers above -->
<filefooter>
End of %projectpathname%
</filefooter>
<filefooter-vb _separators="false">
'---------------------------------------------------------------------------------------------------
' End of %projectpathname%
</filefooter-vb>
<!--
Comment template for catch-all comments. These are added when the filetype of the document
is not one of the core languages that Atomineer can parse to auto-document. The separators
and line headers used for each file extension (e.g. .html, .sql) are configured in your
Prefs.xml, allowing Atomineer to correctly insert simple "boilerplate" comments into any
file format.
-->
<catchall>
<summary />
<_ />
<author>%user%</author>
<date>%date%</date>
<_ />
<seealso />
</catchall>
<!--
Default namespace comment. As with file comments, you can use plain-text or XML commenting for
this entry.
-->
<namespace>
<prototype />
<_ />
<summary />
<_ />
<seealso />
</namespace>
<typedef>
<prototype />
<_ />
<summary />
<_ />
<seealso />
</typedef>
<enum>
<prototype />
<_ />
<summary />
<_ />
<seealso />
</enum>
<bitfield>
<prototype />
<_ />
<summary />
<_ />
<seealso />
</bitfield>
<struct>
<prototype />
<_ />
<summary />
<_ />
<author>%user%</author>
<date>%date%</date>
<_ />
<param />
<_ />
<seealso />
</struct>
<union>
<prototype />
<_ />
<summary />
<_ />
<author>%user%</author>
<date>%date%</date>
<_ />
<seealso />
</union>
<class>
<prototype />
<_ />
<summary />
<_ />
<author>%user%</author>
<date>%date%</date>
<_ />
<param />
<_ />
<seealso />
</class>
<interface>
<prototype />
<_ />
<summary />
<_ />
<author>%user%</author>
<date>%date%</date>
<_ />
<param />
<_ />
<seealso />
</interface>
<module>
<prototype />
<_ />
<summary />
<_ />
<author>%user%</author>
<date>%date%</date>
<_ />
<param />
<_ />
<seealso />
</module>
<!-- C/C++ #define macro -->
<def>
<prototype />
<_ />
<summary />
<_ />
<author>%user%</author>
<date>%date%</date>
<_ />
<param />
<_ />
<seealso />
</def>
<!-- C++ Function Method 头部声明 -->
<method>
<prototype />
<_ />
<summary />
<_ />
<author>%user%</author>
<date>%date%</date>
<_ />
<exception />
<_ />
<param />
<_ />
<returns />
<_ />
<seealso />
</method>
<property>
<prototype />
<_ />
<summary />
<_ />
<exception />
<_ />
<param />
<_ />
<value />
<_ />
<seealso />
</property>
<indexer>
<prototype />
<_ />
<summary />
<_ />
<exception />
<_ />
<param />
<_ />
<returns />
<_ />
<seealso />
</indexer>
<delegate>
<prototype />
<_ />
<summary />
<_ />
<author>%user%</author>
<date>%date%</date>
<_ />
<exception />
<_ />
<param />
<_ />
<returns />
<_ />
<seealso />
</delegate>
<constructor>
<prototype />
<_ />
<summary />
<_ />
<author>%user%</author>
<date>%date%</date>
<_ />
<exception />
<_ />
<param />
<_ />
<seealso />
</constructor>
<destructor>
<prototype />
<_ />
<summary />
<_ />
<author>%user%</author>
<date>%date%</date>
<_ />
<exception />
<_ />
<param />
<_ />
<seealso />
</destructor>
<finaliser>
<prototype />
<_ />
<summary />
<_ />
<author>%user%</author>
<date>%date%</date>
<_ />
<exception />
<_ />
<param />
<_ />
<seealso />
</finaliser>
<operator>
<prototype />
<_ />
<summary />
<_ />
<author>%user%</author>
<date>%date%</date>
<_ />
<exception />
<_ />
<param />
<_ />
<returns />
<_ />
<seealso />
</operator>
<eventhandler>
<prototype />
<_ />
<summary />
<_ />
<author>%user%</author>
<date>%date%</date>
<_ />
<exception />
<_ />
<param />
<_ />
<returns />
<_ />
<seealso />
</eventhandler>
<eventsender>
<prototype />
<_ />
<summary />
<_ />
<author>%user%</author>
<date>%date%</date>
<_ />
<exception />
<_ />
<param />
<_ />
<returns />
<_ />
<seealso />
</eventsender>
<member>
<summary />
</member>
<!-- Templates for methods in abstract classes and interfaces -->
<interfacemethod>
<prototype />
<_ />
<summary />
<_ />
<param />
<_ />
<returns />
<_ />
<seealso />
</interfacemethod>
<interfaceproperty>
<prototype />
<_ />
<summary />
<_ />
<value />
<_ />
<seealso />
</interfaceproperty>
<interfaceindexer>
<prototype />
<_ />
<summary />
<_ />
<param />
<_ />
<returns />
<_ />
<seealso />
</interfaceindexer>
</DoxygenTemplates>