问题标签 [atomineer]
For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.
vb.net - Atomineer Utils VB.NET XML 注释文档不起作用
我刚刚下载了这个应用程序的试用版,它似乎不起作用。我浏览了快速设置指南,一切看起来都很棒。现在,当我将光标放在任何类型的成员上并按 Ctrl+Shift+D 时,它什么也不做。我把它放在上面,里面等等......什么都没有。如果我在成员顶部按 Ctrl+Shift+A(两次),它会告诉我将其放置在“MyType myVariable; 形式的行中”。我不太确定这意味着什么,除非它指的是 C#,但这个项目是 VB.NET,它似乎无法识别。其他人有这个问题吗?我希望它能让事情变得更容易,因为我已经读过它可以记录整个文档,而不必逐个成员。
使用 VS 2010 高级版。
xml - 在 Atomineer 中修改规则
我在评论块中使用@remarks 和@ingroup,但是当我运行Atomineer 时,它一直将它们标记为删除,我不知道如何防止它这样做。我查看了 .XML 配置文件中的修改规则,但我显然遗漏了一些东西。
使用 Atomineer 处理之前的示例:
使用 Atomineer 处理后的示例:
文档说:“设置您的 Doxygen 或 DocXML 模板以指示新评论格式中的‘合法’条目,以及它们应如何在新评论块中排序。任何在旧格式和新格式中具有相同标签的条目(例如 param -> param)将自动“转换”(以新样式重新格式化)。任何不被 AtomineerUtils 视为“合法”的条目都将被标记为带有###前缀的“已删除”。
任何指示或想法将不胜感激?我真的需要它停止这样做。
谢谢!
c++ - 使用 Atomineer 时为每种文件类型单独模板
我正在使用Atomineer 7.31 来格式化我的 C++ 文件,但是我在为不同的文件类型创建单独的行为时遇到了麻烦。例如,我想用某些信息填充我的 .cpp 文件,例如包括与该文件同名的 .h 文件,并包括我的内存跟踪器,并且我希望 .h 文件有一个定义守卫和类的基础知识。
我想要的 .h 文件示例:
还有一个我想要的 .cpp 文件示例:
我希望在空白文件的顶部插入 3 个正斜杠时出现上述每种行为(基于所使用的文件类型)(我相信这是默认的 Atomineer 行为)。我查看了http://www.atomineerutils.com/rulesguide.php以及 Atomineer 中包含的 .xml 文件(File.xml、Namespace.xml、DoxygenTemplates.xml、UserVariables.xml 等),但是我找不到任何迹象表明我是否可以做我需要的事情。
File.xml 中有一个小例子,文件顶部的注释中使用了不同的信息(例如,头文件会说“Declares class xxx”,而 .cpp/.c 文件会说“Implements class xxx”);但我无法模仿这种行为。
我知道可以使用的 %extension% 变量和 < If /> 命令,但我似乎无法得到我想要的。我还尝试以与 File.xml 类似的方式使用 Namespace.xml 文件(File.xml 声明要使用的 %fileDescription% 变量,该变量用于处理文件是否显示“Declares class xxx”或“实现类 xxx"),但我无法让 Namespace.xml 显示任何内容。
File.xml 示例:
然后在 DoxygenTemplates.xml 中使用该信息:
我尝试在 %ip% (输入位置:鼠标光标将出现的位置)上方插入几件事,但无济于事。我觉得问题的一部分可能是我无法让 Namespace.xml 显示任何内容。例如,在 %ip% 上面我放了 %namespaceDescription% 并且我在 Namespace.xml 中有一个简单的 < Set desc="Hi" />,但它没有显示。我将不胜感激任何帮助解决这个问题,谢谢!
c++ - Visual Studio 2013 未正确处理 Doxygen 多行注释
我正在使用带有 Atomineer Utils 插件的 Visual Studio 2013 (C++)。
来自 Java 背景,我对 Doxygen 文档风格很感兴趣,所以我将 Atomineer 配置为使用这种Doxygen (Javadoc)
风格,它基本上看起来像这样:
但是,假设我想开始多行评论。来自 IntelliJ IDEA,我认为这会起作用:
enter
或者更好:
enter
实际上,这会产生最奇怪的结果:
enter
希望您能理解这种自动完成行为是多么无益。
最重要的是,如果您设法获得完整的 Doxygen 评论,则仅在以下情况下扩展该评论才有效(根据我的观察):
- 您没有选择评论的开头 (
/**
) 您在点击之前选择星号之后enter,而不是在它之后自动生成的空格:(
|
代表光标)然后击中enter会起作用,但不是
/li>或者您在该行上输入一些内容并按回车键
现在谈谈我希望如何解决这个问题:以某种方式修复多行注释生成和自动扩展,使其与我期望的相似。
但是,如果你们确定这种解决方案不存在,那么我知道 Atomineer 会在我输入时自动生成文档///
(但为什么不/**
!?),我可以使用它作为一种解决方法。
到目前为止我已经尝试过:
在选项 -> 文本编辑器 -> C/C++ -> 高级下禁用
Complete Multiline Comments
(这将禁用它和 Atomineer 的文档生成器)在选项 -> 文本编辑器 -> C# -> 高级下禁用
Generate XML documentation comments for ///
(我们在这里谈论 C++,所以显然这没有做任何事情)
c++ - Atomineer:确定返回类型是否为 const
我正在使用Atomineer 9.00 来格式化我的代码注释,但我很难确定返回类型是否const
存在。文档指出,对于MethodReturns , using%type%
将提供完整的返回类型(给出的示例是:) const int*
:
方法返回
用于为方法(VB 函数)的返回值生成描述的规则。在本节中可以使用以下特殊变量:
%type% 方法的返回类型 (const int*)
%typeBase% 方法的返回类型,不包括任何修饰符 (int)
但是,当我使用%type%
它时会省略const
. MethodReturns.xml 中的一个示例:
这将为该方法生成以下内容:
我已经尝试了所有其他变体:(%typeBase
来自 MethodReturns.xml)甚至%retTypeBase%
, %retType%
, %typeBase%
and %specialType%
(这些都在确定返回类型时在 Methods.xml 中记录方法时提到)但这些都不包括const
.
我还尝试了其他几种类型(double
和std::string
custom struct
),所以它不仅仅是int
.
正如您从上面的示例中看到的,我已经验证了我设置的描述肯定是被调用的描述。
此外,这似乎与 Parameters.xml 完全兼容(确定参数类型是否const
存在);但是,它似乎在 Methods.xml 中不起作用(%retType%
可用于使用修饰符确定返回类型)
如何确定方法是否返回 aconst
?
documentation - 卸载原子
看起来我被 Visual Studio 的 Atomineer Pro 文档插件扣为人质了!试用期结束了,我没用了!但是现在每次我在 Visual Studio 中做某事时,我都会收到一条错误消息并被发送到他们的网站!
我已经四处寻找如何卸载它,但还没有找到卸载它!
警告所有人 - 这个 Atomineer Pro 不容易卸载!!仅从卸载它的问题来看,我强烈建议没有人安装它!
c# - Atomineer 和具有通用约束的文档化方法
我正在使用 Atomineer 在我的代码中自动生成文档注释。一切似乎都工作正常,除了我遇到了一个问题,即在具有多个通用约束的方法上获取文档注释:
注释将在具有如下约束的方法上自动生成:
Public void Test<T>() where T : IEntity
...但是,当我有多个这样的约束时,不会生成文档注释,并且输出中不会出现错误。
Public void Test<T>() where T : class, IEntity
我在 Atomineer 用户手册中找不到解决方案。
在此解决方案中,我有许多具有多个约束的通用方法,我需要为其提供文档。我可以手动输入它们,或者我可以删除约束,生成文档,然后替换它们,但是有这么多我会花几天时间。
也许有一个配置解决方案我不知道并且被忽略或从用户手册中丢失。
xml-documentation - 每个解决方案的 Atomineer 首选项
使用Atomineer Pro Doc for VS,是否可以将(一些?)设置/首选项保存在当前$(SolutionDir)
目录中?我意识到有一个选项可以prefs.xml
通过在常规设置/首选项存储下设置搜索路径来从默认位置以外的位置保存/使用文件,但是这些看起来需要绝对路径,而我的问题是关于能够定义相对于当前解决方案/项目文件的此类路径。