Atoms代码生成后修改注解配置防止重新生成覆盖

Atomineer Pro Documentation插件默认会对注解进行全量覆盖，若想启用增量更新，需勾选【Update existing comments】；你可以使用@atomineer-ignore标记来保护特定内容；通过配置preserveCustomTags可保留自定义标签；此外，还能通过.atomineerignore文件来禁用特定路径的注解生成。

在 Atom 中使用代码生成插件（如 Atomineer Pro Documentation）自动生成注解后，若直接手动修改生成的注解内容，下次触发重新生成时会被无条件覆盖——因为插件默认采用“全量覆盖”策略，不识别已有注解是否被人工调整过。

确认 Atomineer 是否启用增量更新模式

进入Atom设置，找到Packages，搜索atomineer，点击Settings，然后找到

选项并勾选。这个选项决定了插件是否会跳过已经存在且格式正确的注解块。如果不勾选，那么无论原注解有没有被改动，每次生成都会强制重写整段。

注意：此开关仅对符合插件识别规范的注解生效，例如 Ja vaDoc 的 /** ... */ 块必须以 /** 开头、*/ 结尾，且中间不能有空行断裂。

锁定关键字段防止被覆盖

Atomineer 支持通过特殊标记保护部分注释内容不被重写：

方法一：在要保留的手动修改行前加 // @atomineer-ignore-next-line

方法二：对整个注释块添加保护标记：/* @atomineer-ignore */ 开头，/* @atomineer-end-ignore */ 结尾

这两类标记必须独占一行，且大小写敏感。插入后，Atomineer 在生成或更新时会跳过被标记的行或块，但其余部分仍正常刷新。

配置注解模板避免冲突性重写

第一步：进入 Atom → Config → Edit Config File（打开 config.cson）

第二步：在 atomineer: 节点下添加以下配置：

preserveCustomTags: true

customTagPrefixes: ["@api", "@note", "@todo"]

第三步：保存 config.cson 并重启 Atom

启用

后，插件将保留所有以指定前缀开头的自定义标签行（如 @api stable），即使它们不在原始模板中定义。这能防止你添加的业务语义标签被清空。

禁用特定文件的自动注解生成

若某类文件（如 DTO、测试类）你始终手动维护注解，可彻底关闭其生成行为：

在项目根目录创建 .atomineerignore 文件

逐行写入需排除的路径模式，例如：

src/main/ja va/**/dto/*.ja va

src/test/**

该文件支持 glob 通配符，匹配成功后 Atomineer 对这些路径下的任何文件都不再触发注解生成或更新操作。