Idea 文件注释和 java 方法注释

本贴最后更新于 2944 天前,其中的信息可能已经事过境迁

规范

一个很好规范,应该包括注释这部分。

初始

在 Idea 中,刚开始创建一个文件的时候,都会由一个这样的注释说明

/**
 * Created by 作者 on 2016/9/1.
 */

问题

我们有时候可能会向,当文件创建的时候,除了应该由的注释,能不能加点其它的东西呢,或者改成我们想要的注释呢?

解决

  1. 打开 setting(快捷键 ctrl+alt+s),找到 > File and Code Templates

ab046e149e7e447ab957c575996b27ed-QQ20161129114232.png

2 . 一般的文件在 File Header 中设置,想设置的具体变量在图片右下方 Description 中有具体描写。

其它

如果想在 Java 中方法上编写类似的注释。比如 Sym 里的这部分,应该在 Setting(快捷键 ctrl+alt+s),找到 > Live Templates 中设置
c0a6196641904dc388b2a17be1adf79c-QQ20161129114232.png

live templates 中可以设置类似 java 方法上的注释,也可以设置快捷键;(比如:输入 sout,按下 tab 就能出现 System.out.println()

Live Templates

000e94de13864b01a5e0b1da38bc9cb7-QQ20161130193059.png

如图,在 Live Templates 绿色加号下有两个选项,其中一个是 Templates Group 就是模板组,里面可以包含许多 Live Templates 模板。另一个 Live Templates 才是我们要设置的模板。我们可以新建一个属于自己的模板组,再创建一个新的 Live Templates 模板。
d2b32a09bf764628af6047ec0ebc6fb6.png

Templates text 中

/**
 * $Method$ 
 $Param$
 */
  • 两个 $ 之间的是预设变量名,点击 Edit variables,来设置它们具体代表的含义
    16deb5b397124a0299d2c82202d08659.png

  • Abbreviation 是要设置的快捷键,Description 来描述它们。
    af709ed9e74c48549cc811f92d26d659.png

  • 也可以试着加其它写东西,比如:日期,用户等等。。。

测验

找到一个类,输入预设快捷键,OK。更多详见这里
好像没有 throws 的有关设置,我只能自己打上去。
44e1693894dd401084a9f1f96a002cea.png

  • IDEA

    IDEA 全称 IntelliJ IDEA,是一款 Java 语言开发的集成环境,在业界被公认为最好的 Java 开发工具之一。IDEA 是 JetBrains 公司的产品,这家公司总部位于捷克共和国的首都布拉格,开发人员以严谨著称的东欧程序员为主。

    181 引用 • 400 回帖
  • Idea注释
    1 引用 • 7 回帖
  • 规范
    7 引用 • 41 回帖

相关帖子

欢迎来到这里!

我们正在构建一个小众社区,大家在这里相互信任,以平等 • 自由 • 奔放的价值观进行分享交流。最终,希望大家能够找到与自己志同道合的伙伴,共同成长。

注册 关于
请输入回帖内容 ...
  • someone3608

    顶,感谢分享.

  • 其他回帖
  • ZephyrJung

    感谢楼主分享

  • yangyujiao

    😓,以前用 eclipse,自动生成的方法都是带着头上的注释的。idea 不会搞····。。。

    1 回复
  • yangyujiao

    为什么我照着设定的,但是结果不理想呀····。
    cc0ca0ffd8b74cb08b1a410f1fa9bff9.png

    0022aa33dc6b491aa53d3339fcc7ed2c.png

    35515ac11d724203a8bb2670922975fc.png

    为什么我的出的是第三张图那样的,要改哪里? 还是我有什么没有配置好的。。。、

    求指教。。。

    1 回复
  • 查看全部回帖