【问题标题】:Adding a standard comment header to all source files in eclipse为eclipse中的所有源文件添加标准注释头
【发布时间】:2010-11-05 12:03:56
【问题描述】:

有没有办法在一个地方添加一个标准的标题注释,它将应用于我项目中的所有源文件?标题将包含我的姓名、联系方式、公司、许可证等。

【问题讨论】:

标签: eclipse


【解决方案1】:

如果您正在寻找具有良好 Eclipse 集成(以及良好的 GUI)的工具,我建议:Eclipse Copyright Generator

这增加了:

  • 首选项中的新面板(全局或基于项目)具有: 菜单 > Windows > 首选项 > 常规 > 版权
  • 菜单菜单>项目>申请版权...
  • 一个非常棒的向导,有很多选项和一些用于开源许可证(Apache、EPL、...)的默认模板

我刚刚用 eclipse 3.6 试了一下,效果很好。

有一个更新站点可以安装它:

https://dl.bintray.com/jmini/Eclipse-Copyright-Generator/

【讨论】:

  • 刚刚碰到这个答案:很棒的工具。谢谢!
  • w91dev 好像下线了 :(
  • @rec:在 sourceforge 上似乎仍然可以使用源代码。让我们希望有人会调查它,编译项目并将其发布到其他地方的更新站点。这是开源软件的问题之一。
  • 想象一下它不是开源的——那么它将永远消失。像这样,至少有人可以重新发布它,甚至可以接管 sourceforge 上的项目。
  • 新版本发布在 GitHub/Bintray:jmini.github.io/Eclipse-Copyright-Generator
【解决方案2】:

窗口 > 首选项 > Java > 代码样式 > 代码模板 > 注释 > 文件

【讨论】:

  • 类似Window > Preferences > Java > Code Style > Code Templates > Code > New Java Files可以用来为新的Java代码设置标准的注释头
  • 此外,请确保在 Java - 代码样式 - 代码模板部分的下部启用了“自动为新方法添加 cmets”复选框。
【解决方案3】:

除了Bozho提供的答案,还有eclipse提供的releng工具,给你一些菜单项命令来修复现有文件的版权。您可以从此更新站点安装 releng 工具:

Eclipse 项目更新 - http://download.eclipse.org/eclipse/updates/4.3

这里有一些关于它的信息:

https://wiki.eclipse.org/Development_Resources/How_to_Use_Eclipse_Copyright_Tool

【讨论】:

  • 链接对我来说效果很好,我猜它们已经更新了。
  • 我使用的是 3.8.1,但这个版本的更新可能不存在。因此尝试使用较低版本的 3.7 更新。 download.eclipse.org/eclipse/updates/3.7 确实为我安装了工作。 @Andrew:对此版权文本中支持的“变量”列表的任何引用,例如 ${date} 就是一个。我需要知道,有些像 ${file}、${user}、date-in-dd/mm/yyyy 格式等。
  • 这适用于 java 但不适用于 scala。 scala 文件的任何选项?
【解决方案4】:

除了 Andrew Eisenberg 的回复之外,这是我发现的关于 Eclipse copyright tool 的信息。我发现这在所有建议的解决方案中效果最好。

优点:

  • 易于更新版权年份或许可标题。
  • 易于应用于整个项目或只是其中的一部分。

缺点:

  • 不适用于所有类型的文件。至少在 JSP 上不起作用 给我的文件。
  • 您不能设置多个许可证并将它们应用为 你希望。只有一个许可证。

定制(来自偏好):

您可以在文件或包级别应用许可证

【讨论】:

  • 此工具不再可供安装
  • @SergeyKarpushin 您必须从较旧的更新站点对其进行配置。我从 4.19 Eclipse 更新站点安装了我的,它工作正常。
【解决方案5】:

@Jmini 链接的项目(Eclipse 版权生成器)似乎已死,您可以使用此插件添加标题:JAutoDoc,它非常易于使用并且有很多用于 javadoc 的实用程序。

您需要在project|general > Preferences > java > JAutodoc > FileHeader 中指定许可证,然后在项目中使用:project > JAutodoc > Add Header,确保选项Replace Existing Header 已打开。

模板使用Velocity编写,因此您可以将所需的所有信息添加为变量。

【讨论】:

    【解决方案6】:

    这是我在Window > Preferencers > Java > Code Style > Code Template > Code > New Java files下的设置:

    /*
     * Copyright (c) 20XX XXXXXXXXX. All rights reserved. Whatever......
     */
    
    ${filecomment}  
    ${package_declaration}  
    
    ${typecomment}  
    /**  
     *   
     * @author ${user}  
     *  
     */  
    ${type_declaration}  
    

    【讨论】:

      猜你喜欢
      • 2019-09-17
      • 2021-03-10
      • 1970-01-01
      • 1970-01-01
      • 2015-10-04
      • 2020-01-08
      • 1970-01-01
      • 1970-01-01
      • 2023-04-03
      相关资源
      最近更新 更多