Android Studio：如何删除/更新添加到所有新类的“创建者”注释？

Posted 2023-02-23

【中文标题】Android Studio：如何删除/更新添加到所有新类的“创建者”注释？

【英文标题】：Android Studio: how to remove/update the "Created by" comment added to all new classes?

【发布时间】：2013-12-05 05:29:03

【问题描述】：

默认情况下，android Studio 会自动为所有新类添加标题注释，例如

/**
 * Created by Dan on 11/20/13.
 */

自定义或删除的设置在哪里？

【参考方案1】：

从菜单栏：

在 Mac OS 上选择 Android Studio -> Preferences 在 Windows 和 Linux 上选择 File -> Settings

然后在左侧窗格中查找Editor -> File and Code Templates。

你有两种方法可以改变它...

1) 选择Includes 选项卡并直接编辑Created by... 文本。

2) 选择Templates 选项卡并为您想要的任何模板编辑#parse("File Header.java") 行。

我个人遵循选项 1) 并将默认标题注释设为 TODO，例如

/**
 * TODO: Add a class header comment!
 */

这些说明基于 Android Studio v0.3.7。并且还在 v1.2.1.1 上测试过

【讨论】：

在我的 Android Studio 0.3.2 - 我在 File -> Settings

下找到了 File and Code Templates

在哪里可以更改用户名？

如果你想删除现有的 cmets，你可以使用这个正则表达式 Edit -> Find -> Replace in Path...：/\*\*\n \* Created by .*\n \*/

+1 工作就像一个魅力！非常感谢你！你拯救了我的一天。

知道如何将此模板应用于现有文件吗？谢谢！

【参考方案2】：

您可以使用 #set( $VARIABLE = "value") 函数覆盖模板文件中的 $USER 变量。

On windows: Press Ctrl+Alt+S and go to Settings -> File and Code Templates -> Includes -> File Header

On Mac: Android Studio -> Preferences -> Editor -> 
File and Code Templates -> Includes -> File Header

添加#set() 函数调用，例如：

#set( $USER = "YourName" )
/**
* Created by $USER on $DATE.
*/

【参考方案3】：

除了 Dan 的回答（这是更严格的方式），您还可以单击标题，然后选项输入（在 Mac 上），您可以选择编辑默认文件模板。或者，点击小灯泡也可以到达这里

【参考方案4】：

更改 Android Studio 文件头模板

第 1 步： 首先将鼠标悬停在 文件头 上，点击黄色灯泡和菜单，如下图所示： p>

第二步：然后点击编辑模板菜单项，弹出如下窗口：

注意：在它的描述区还有很多其他可用的模板变量，你也可以使用它们。

第 3 步： 在编辑器区域中添加您的姓名，如下图所示，然后单击 “确定” 按钮以及当前文件和未来新的类文件头会相应生成。

希望这个答案对其他人有帮助！ :-) 干杯！ （这适用于 Android Studio 2.2（2015 年 9 月）版本。）

【参考方案5】：

接受的答案有 Android Studio v0.3 的说明。所以我决定为 Android Studio 3.0.1 添加说明

转到 Android Studio Preferences-> CopyRight->CopyRightProfiles 并点击 [+] 添加新配置文件或编辑现有配置文件。

创建或更新版权模板，可以从下面复制一个示例模板：

创作者：Hitesh Sahu 在 $today 最后修改：$file.lastModified 版权所有：保留所有权利Ⓒ $today.year http://hiteshsahu.com

根据 Apache 许可证 2.0 版（“许可证”）获得许可；除非遵守许可，否则您不得使用此文件。 您可以在以下网址获取许可证的副本 http://www.apache.org/licenses/LICENSE-2.0 除非适用法律要求或书面同意，否则根据许可分发的软件按“原样”分发 基础，没有任何形式的保证或条件，无论是明示或 默示。请参阅许可证以了解具体的管理语言 许可下的权限和限制。

现在选择新创建的版权作为您的默认版权配置文件

最后更新整个项目的版权，如下所示

【参考方案6】：

按 ctrl+shift+A 类型：文件和代码模板。 在包含下查找文件头 您可以输入如下内容

【讨论】：

但是如何将它包含在现有的 Java 文件中，其中没有包含文件头？

【参考方案7】：

如果您想删除所有已创建的 cmets。点击 Ctrl + Shift + R 以打开 在路径中替换 对话框。检查正则表达式选项并替换

/\*\*\n \* Created by .*\n \*/

什么都没有。

---

_{正则表达式最初是由 nerdinand 作为对以下answer 的评论发布的。虽然我问过他，但他好几个月都没有给出答案。这就是我现在这样做的原因，这样人们可以更容易地找到它。}

【讨论】：

这个不错。但是，它不会删除那些将 is 作为整体的一部分。

@androiddeveloper 你是什么意思？请举个例子

我的意思是，如果 JavaDocs 有多个“创建者”，它会跳过它们。

@androiddeveloper 这绝不应该删除 JavaDoc cmets，只有文件顶部的“创建者”注释（正如 OP 所要求的那样）。 :)

我的意思是一样的。您可以在其中添加比“创建者”部分更多的文本。

【参考方案8】：

您也可以禁用警告。对我来说，默认模板没问题，但看到黄色突出显示的类 javadoc 让我很烦。因此，要禁用它，请转到设置 -> 编辑器 -> 检查 -> 常规 -> 取消选中“默认文件模板使用”。

您也可以在所有项目中执行此操作。只需在同一检查选项卡中将项目配置文件更改为默认。

【参考方案9】：

设置->编辑器->版权->版权配置文件

是另一个地方（除了“设置->编辑器->文件和代码模板”），可以定义类似的模板，也可以在创建文件时触发。