注释_spring boot 多行注释 时间注释 版本注释 - CSDN
  • Java注释: //:行注释,单选注释。用于某行代码后面 /**/:块注释。//的升级版,用来注释多行代码,也可以写多行注释 /***/:javadoc注释。同上,但是能写入javadoc文档说明,用来生成HTML格式的代码报告,所以...

    Java注释:

    //:行注释,单选注释。用于某行代码后面

    /**/:块注释。//的升级版,用来注释多行代码,也可以写多行注释

    /***/:javadoc注释。同上,但是能写入javadoc文档说明,用来生成HTML格式的代码报告,所以注释文档必须写在类、域、构造函数、方法,以及字段(field)定义之前。注释文档由两部分组成——描述、块标记。

    jsp注释:

    <!-- 注释内容 --> : HTML注释。内容可见,出现在生成的HTML代码中,浏览器会忽略此注释

    <%-- 注释内容 --%> : JSP页面注释。标记的内容客户端查看源码时是完全看不到的。JSP注释只在JSP代码中可见。
    <% // 注释内容 %> : Java注释。单行注释,显示在servlet代码中,不显示在响应中
    <% /* 注释内容 */ %> : Java注释。多行注释,同上

    mysql注释:

    #这是注释: 单行注释

    --  这是注释:同上,--后面是有空格的

    /* 这是注释 */ :多行注释

     

    展开全文
  • 我在很多地方看到这样一个观点,“请停止写注释,因为只有烂的代码才需要注释。”这个观点非常巧妙,它让我想起了孟子的一句话,“杨氏为我,是无君也;墨氏兼爱,是无父也。无父无君,是禽兽也。” 动不动就骂别人...

    我在很多地方看到这样一个观点,“请停止写注释,因为只有烂的代码才需要注释。”这个观点非常巧妙,它让我想起了孟子的一句话,“杨氏为我,是无君也;墨氏兼爱,是无父也。无父无君,是禽兽也。”

    动不动就骂别人是“禽兽”,我总觉得有点不妥,这很不符合孟子的浩然之气啊。有些大牛也有孟子这样的觉悟,如果有人要他给自己的代码加上注释,就好像是对他的一种侮辱:“我的代码写得这么优雅,你难道看不懂吗?注释是多余的!”

    我必须得承认,每个程序员都应该有一颗追求“优雅”的心,力争自己的代码更易阅读和理解——不只是针对机器,还有我们程序员同行。但不是每个程序员在一开始都能写出“高标准”的代码的,就好像不是所有君王和百姓都能搞清楚孟子的治国齐家理念的。

    在我刚回洛阳的那段时间,过得非常痛苦。因为我刚接手了别人留下的一个项目,关于大宗期货交易的。后端代码是用 Java 写的,但有很多 bug 在里面,动不动就资金结算失败,甚至内存溢出,要解决这些问题,只有一个办法,就是彻底搞懂这些代码。

    否则,根本无从下手。这就好像,你和朋友开车出去自驾游,去很远很远的地方,朋友开累了,需要休息,这时候,如果你没考过驾照,那就抓瞎了,只能把车停路边,等朋友的疲劳消退了,才能继续上路。

    我就抓瞎了。凭良心说,前同事留下的代码是精彩绝伦的,如果换做是我来写,真不一定能写得出来。毕竟大宗期货交易本身还是有点难度的,需要竞价撮合,这个业务理解起来比股票还要复杂些。

    股票涨了就赚,跌了就亏。期货不同的,买涨能赚,买跌也能赚。不过业务上的复杂还是次要的,重要的是代码里的注释非常稀有,就好像詹姆斯高斯林头上的发丝一样稀有。

    况且,国内程序员的英语功底你懂的,变量、方法、类、接口、枚举的命名无法做到真正意义上的名如其意。再加上,有些方法的行数多达三四百行,从头看到尾,看得只想捶自己。

    没办法,我的解决办法就是,看懂一行就加一行注释,毕竟注释总比代码要容易理解啊。就好像,我们在调用一个不熟悉的 API 时,只要代码的文档说清楚它是干嘛的,我们就可以用,就敢用,至于实现的细节,暂时没有理解也没关系。

    差不多花了两个月的时间(非常漫长、非常煎熬)吧,我总算是把项目中核心的代码给研究清楚了。搞清楚之后,那些之前怎么改都改不掉的 bug 也就迎刃而解了。

    这也就是为什么,我倡导大家去读源码的一部分原因了,除了学习,读源码是解决 bug 的杀手锏。要读懂源码,注释是必不可少的。不信,你看看 Java 的源码,每个变量、每个方法、每个类,注释都非常详细,详细到你替源码的作者感到心累。

    在我看来,Java 源码的作者绝对是这个世界上最优秀的程序员,连他们都写注释,那些声称“请停止写注释”的号召者是不是要啪啪啪地打脸,直到打肿为止。

    不要怀疑自己,写注释并不会证明你的代码就是烂代码。我相信,你应该买过电子产品,比如说鼠标、键盘、耳机、手机等等,所有的产品包装里除了产品本身,使用说明书是必不可少的。我就问一句,“手机没有使用说明书,咱这些后浪还能不会用?”

    写注释不是我们的错,软件本来就是复杂的。尤其是我们这些英语不是主力语言的人来说,注释显得尤为重要。我可能属于记忆力不好的那一种,隔个十天半个月,再去回头看那些我自己敲的代码,有时候真有点见着陌生人的感觉:“这代码是我写的吗?怎么有点面生啊?”

    大部分人写的代码都要升级重构,对吧?不论是语言本身版本的升级,还是我们自身能力的成长。假如在升级重构的时候,没有这些注释的帮助,真有点爬泰山的感觉,累啊,亲。

    再者说,大牛也不敢保证自己的代码是没有问题的,对吧?但注释是不会骗人的,它的意义是明确的。你可能会忘记代码是干嘛的,但我敢保证,注释能够唤醒你的记忆。

    写出好的、有意义的注释其实是有难度的,就像写代码一样。在追求卓越的路上,代码和注释其实是相辅相成的。注释会让你的代码更易阅读,代码会让你的注释更富有逻辑。

    即便是你的代码已经优雅到不需要注释,那只是在你的层面上。对于你的同事,你代码后来的负责者,就不一定了。所见略同的英雄并不会很多,你以为很优雅的代码没准在别人眼里就是一坨垃圾,而你的注释很可能会帮助别人“恍然大悟”,明白代码的意义。乖乖地写注释吧,对你对别人都有好处。

    另外,我想说一句,注释就好像是代码的一个蓝图,也或者是对代码的一个总结。在你写代码之前,脑子里肯定要想清楚你要实现什么,怎么实现,把这些作为注释写下来绝对可以帮助你写出更优雅的代码。在代码写完之后,通过注释进行总结,还能对代码进行一些升华,没准还能在总结的过程中想到更好的代码方案。

    我还见到有大牛信誓旦旦地说,写注释就好像是给不会游泳的人扔一个救生圈,他永远也学不会游泳。咋眼一看,这句话说得很有道理,对吧?在大牛们看来,要让一个新人快速成长,最好的办法就是把没有注释的代码扔给他看。

    纯属扯淡,恐怕这个新人没入门就放弃了吧?我已经三十一岁了,不,我已经十八岁了,还不会游泳呢?别听那些大牛们的鬼话,我就不信,他自己没写过注释。

    总之一点,注释并不会妨碍你写出优雅简洁的代码,它只是程序固有的一部分而已

    如果觉得文章对你有点帮助,请微信搜索「 沉默王二 」第一时间阅读。本文已收录 GitHub,传送门~ ,里面更有大厂面试完整考点,欢迎 Star。

    我是沉默王二,一枚有颜值却靠才华苟且的程序员。关注即可提升学习效率,别忘了三连啊,点赞、收藏、留言,我不挑,嘻嘻

    展开全文
  • §单行注释// 这是单注释 §多行注释/*这是多行注释*/ §Javadoc注释/**这是javadoc注释*/ 其实这里面还有很多细节呢,下面我们一一来揭晓 在这里相信有许多想要学习Java的同学,大家可以关注小编公众号卓越新...

    前言

    今天我们来说说如何编写Java注释。使用过Java的同学都非常熟悉,Java中有:

    §单行注释// 这是单注释

    §多行注释/*这是多行注释*/

    §Javadoc注释/**这是javadoc注释*/

    其实这里面还有很多细节呢,下面我们一一来揭晓

    在这里相信有许多想要学习Java的同学,大家可以关注小编公众号卓越新腾。

    哪些地方需要添加注释

    首先,我们需要确定一下,添加注释的目的是什么?(手动思考10秒)。

    我认为添加注释,是为了程序更容易理解与维护,特别是维护,更是对自己代码负责的一种体现。

    那基于这样的目的,在日常开发中,我们需要在哪些地方添加注释呢?

    §类,接口。

    这一部分注释是必须的。在这里,我们需要使用javadoc注释,需要标明,创建者,创建时间,版本,以及该类的作用。如下所示:

    package com.andyqian.utils;/*** @author: andy* @date: 18-01-05* @version: 1.0.0* @deion: 生成PDF 工具类*/public class PdfUtil {}

    §方法

    在方法中,我们需要对入参,出参,以及返回值,均要标明。如下所示:

    /** * 生成pdf文件 * @param htmlContent 待生成pdf的 html内容 * @param file 生成pdf文件地址 * @see PdfUtils#getFontPath() * @return true 生成成功 false 生成失败 */ public static boolean generatePdf(String htmlContent,File file){ ... return result; }

    §常量

    对常量,我们需要使用多行注释,进行标明该常量的用途,如下所示:

    /*** @author: andy* @date: 18-01-05* @version: 0.0.1* @deion:*/public class StatusConsts { /** * 博客地址 */ public static final String BLOG="www.andyqian.com";}

    §关键算法上

    在关键算法上,添加注释并且按照顺序依次标明,写明白该方法为什么这么做。如下所示:

    /** * 应用场景: * 1.在windows下,使用Thread.currentThread()获取路径时,出现空对象,导致不能使用 * 2.在linux下,使用PdfUtils.class获取路径为null, * 获取字体路径 * @return 返回字体路径 */ private static String getFontPath(){ String path=""; // 1. ClassLoader classLoader= Thread.currentThread().getContextClassLoader(); URL url = (classLoader==null)?null:classLoader.getResource("/"); String threadCurrentPath = (url==null)?"":url.getPath(); // 2. 如果线程获取为null,则使用当前PdfUtils.class加载路径 if(threadCurrentPath==null||"".equals(threadCurrentPath)){ path = PdfUtils.class.getClass().getResource("/").getPath(); } // 3.拼接字体路径 StringBuffer stringBuffer = new StringBuffer(path); stringBuffer.append("/fonts/SIMKAI.TTF"); path = stringBuffer.toString(); return path; }

    怎么添加注释?

    1. IDEA 自动生成

    对于类中的注释,我们可以通过IDEA自动生成。

    如IDEA 可以通过:File->Settings->Editor->File and Code Templates->Includes->File Header来设置模板,这样新建文件时,IDEA会按照设置的模板,会自动生成一个注释,就不需要一个一个敲了。

    其中标签有:

    ${USER} : 当前用户。

    ${DATE} : 当前日期。

    ${PACKAGE_NAME}:包名。

    ${TIME}: 当前时间。

    ${YEAR}: 当前年。

    ${MONTH}:当前月。

    ${DAY}: 当前日。

    ${HOURS}: 当前小时。

    ${MINUTE}: 当前分钟

    1.注释引用

    如果方法中引用了其他的方法,在注释中如何体现呢?细心的朋友,应该已经发现了,在上面的:

    /** * 生成pdf文件 * @param htmlContent 待生成pdf的 html内容 * @param file 生成pdf文件地址 * @see PdfUtils#getFontPath() * @return true 生成成功 false 生成失败 */ public static boolean generatePdf(String htmlContent,File file){ ... return result; }

    中的@see就有这个作用,其语法是:

    @see package.class#method label@see #field@see #method(Type, Type,...)@see #method(Type argname, Type argname,...)@see #constructor(Type, Type,...)@see #constructor(Type argname, Type argname,...)

    例如:

    @see PdfUtils#getFontPath()

    如果是同一个类中,package(包名全路径)可以省略。有相同功能的标签有:

    {@linkpackage.class#metod}

    /** * 生成pdf文件 * @return true 生成成功 false 生成失败 * @throws Exception * {@link PdfUtils#getFontPath()} */ public static boolean generatePdf(String htmlContent,File file){ .... }

    其区别是:@see必须要在注释行首,{@link}可以在任意位置。

    1. 在IDEA中,我们可以选中方法通过快捷键Ctrl+D即可查看我们添加的注释,如下图所示:

    1.如果需要引用外网的连接,我们可以通过HTML标签中的a标签来表示,如下所示:

    @see <ahref="http://www.andyqian.com">博客地址</a>

    以下为javadoc 需要熟知的注释标签:

    @see 引用类/方法。

    @author: 作者。

    @date:日期。

    @version: 版本号。

    @throws:异常信息。

    @param:参数

    @return: 方法返回值。

    @since: 开源项目常用此标签用于创建日期 。

    {@value}: 会使用该值,常用于常量。

    {@link} 引用类/方法。

    {@linkplain} 与@link功能一致。

    完整案例如下:

    package com.andyqian.pdf.utils;import com.itextpdf.text.log.Logger;import com.itextpdf.text.log.LoggerFactory;import java.io.File;import java.net.URL;/*** @author: 鞠骞* @date: 18-01-05* @version: 1.0.0* @deion: 生成PDF 工具类*/public class PdfUtils { private static final Logger logger = LoggerFactory.getLogger(PdfUtils.class); /** * 生成pdf文件 * @param htmlContent 待生成pdf的 html内容 * @param file 生成pdf文件地址 * @see <a href="https://itextpdf.com/">https://itextpdf.com/</a> * @return true 生成成功 false 生成失败 */ public static boolean generatePdf(String htmlContent,File file)throws Exception{ ... return true; } /** * 应用场景: * 1.在windows下,使用Thread.currentThread()获取路径时,出现空对象,导致不能使用 * 2.在linux下,使用PdfUtils.class获取路径为null, * 获取字体路径 * @return 返回字体路径 */ private static String getFontPath(){ String path=""; // 1. ClassLoader classLoader= Thread.currentThread().getContextClassLoader(); URL url = (classLoader==null)?null:classLoader.getResource("/"); String threadCurrentPath = (url==null)?"":url.getPath(); // 2. 如果线程获取为null,则使用当前PdfUtils.class加载路径 if(threadCurrentPath==null||"".equals(threadCurrentPath)){ path = PdfUtils.class.getClass().getResource("/").getPath(); } // 3.拼接字体路径 StringBuffer stringBuffer = new StringBuffer(path); stringBuffer.append("/fonts/SIMKAI.TTF"); path = stringBuffer.toString(); return path; }}

    添加注释时的一点建议

    1.类中,接口等必须有创建时间,创建人,版本号,描述等注释。

    2.注释不是越多越好,比如:get/set方法就不需要写注释。更不需要每一行都写注释。

    3.注释需要写的简明易懂。特别是方法的参数,以及返回值。

    4.每一次修改时,相应的注释也应进行同步更新。

    5.在类,接口,方法中,应该都使用/** */javadoc注释。因为这样调用者就不需要进入方法内部才知道方法的用处。提高编码效率。

    6.方法代码中如果有顺序之分,最好将代码也加上序号,如1,2,3等。

    7.枚举中的每一个值都需要添加注释。

    小结

    写注释是一个好习惯,能让自己和团队都受益,如果你接手一个一丁点注释都没有的项目,那么上一个程序员就倒霉了(此处省略N个字),不知你们有没有看过开源项目的源码,那注释写的相当详细,大家可以多多参考,争取别做一个”倒霉”的程序员。

    展开全文
  • 注释的内容不会出现在字节码中,即java编译器编译时会跳过注释语句,在java中根据注释的功能不同,主要分为单行注释、多行注释和文档注释。 1,单行注释 单行注释是以“//”开头的后面的内容就是注释。 2,多行注释 ...

    注释就是我们在写程序的时候会经常的加入注释,第一方便我们的阅读,第二用来提高程序的可读性。java语言允许程序员在程序中写上一些说明性的文字,这些说明性的文字就是注释。注释的内容不会出现在字节码中,即java编译器编译时会跳过注释语句,在java中根据注释的功能不同,主要分为单行注释、多行注释和文档注释。
    1,单行注释
    单行注释是以“//”开头的后面的内容就是注释。
    2,多行注释
    多行注释是以“/”开头和以“/”结尾的,之间的内容均为注释,我们也可以使用多行注释作为行内注释。但是使用时要注意,多行注释不能嵌套使用。
    3,文档注释
    文档注释是以“/**”开头以“*/”结尾注视中包含这一些说明性的文字及一些javaDoc标签(后期写项目时,可以生成项目的API)
    写注释是一个非常非常好的习惯,建议以后写完每一个方法每一个类上面都写上注释,告诉别人这个方法这个类是干什么的。即使你写的方法名称和类名称写的非常好,可能别人通过这个英文名称就知道是干嘛的了但是仍然建议加上注释,这是一个非常好的习惯,建议你们从一开始就养成这个非常好的习惯。

    展开全文
  • 谈代码注释

    2019-05-09 16:17:31
    只要写代码,就会遇到代码注释的问题。在不同的公司,不同的项目组,不同的项目中,可能会有不同的注释标准。有些标准让我们感觉很受益,有些则让我们感觉很反感。而对于没有明确标准的项目,我们往往会遇到...
  • Eclipse注释与取消注释

    2018-07-22 11:45:52
    单行注释: CTRL + / 当行取消注释(一样的): CTRL + /    多行注释: CTRL + SHIFT + / 多行取消注释(斜杠换成反斜杠): CTRL + SHIFT + \
  • 说明:注释的原则是有助于对程序的阅读理解,在该加的地方都加了,注释不宜太多也不能太少,注释语言必须准确、易懂、简洁。 2.文件注释:文件注释写入文件头部。说明:以/* 开始示例:/ ** 文件名:[文件名]* ...
  • 注释和注解的区别

    2018-09-18 16:34:39
    注解 :参与代码编译,以@开头的。它是给应用程序看的,单独使用注解毫无意义,一定 要跟工具一起使用,这个所谓的工具实际就是能读懂注解的应用程序 。...注释 :对代码没有影响。对代码起到解释、说明的作用; ...
  • 注释 、CSS/JS //注释 和 /*.....*/ 注释 <!-- -->是HTML的注释标签,使用 < 和 > 是符合HTML标签语法规则的。/* */是CSS的注释标签 /* */(注释代码块)、//(注释单行)是JS的注释标签。 两种注释...
  • matlab中进行多行注释

    2014-07-23 14:12:40
    在MATLAB中可以在行首部加%来进行注释,%%
  • 看教程上面说,多行注释用三个单引号 ''' 或者三个双引号 """ 将注释括起来。 但是看有些代码在''' '''内是生效的。如; ``` sql = '''create table students ( name text, username text, id int)''' ...
  • 1、一次性添加多行注释的快捷键 首先选中要注释区域,然后 ctrl+/  这个是多行代码分行注释,每行一个注释符号 ctrl+shift+/ 这个是多行代码注释在一个块里,只在开头和结尾有注释符号 2、取消多行注释...
  • --这是单行注释--&gt; &lt;!--  这是多行注释  这是多行注释  这是多行注释 --&gt; JS/jQuery注释: //这是单行注释 /*  这是多行注释  这是多行注释  这是多行注释 */ css注释: /*这是...
  • IDEA自带的注释模板不是太好用,我本人到网上搜集了很多资料系统的整理了一下制作了一份比较完整的模板来分享给大家,我不是专业玩博客的,写这篇文章只是为了让大家省事。 这里设置的注释模板采用Eclipse的格式,...
  • bat批处理的注释语句

    2012-10-29 19:53:26
    写bat批处理也一样,都要用到注释的功能,这是为了程式的可读性 在批处理中,段注释有一种比较常用的方法:  goto start  = 可以是多行文本,可以是命令  = 可以包含重定向符号和其他特殊字符  = 只要...
  • IDEA可以使用快捷键添加行注释Ctrl+/、块注释Ctrl+Shift+/,还可以快速生成类注释、方法注释等,下面就介绍这几种快捷键的用法. [1]行注释Ctrl+/ 首先你的光标要处于这一行,处于这行的哪个位置都可以,按Ctrl+/,就...
  • 单行注释以"#"开头的行就是注释,会被解释器忽略。#-------------------------------------------- # 这是一个注释 # author:菜鸟教程 # site:www.runoob.com # slogan:学的不仅是技术,更是梦想! #--...
  • Eclipse 中的两种注释方法: (1)多行注释 (2)单行注释 一、 多行注释快捷键 1:添加注释 Ctrl+Shift+/ : 添加/* */注释  示例: 选中代码块后按下快捷键即可 /* float size = 0.0f;  float pct = 0.0f;  try...
  • idea和eclipse的注释还是有一些差别的。idea:类头注释:打开file->setting->Editor->Filr and Code Templates->Includes->File Header 直接在右边的文件框里编辑你说需要注释的东西,然后应用保存之后,当你创建...
  • IntelliJ IDEA设置类注释和方法注释模板1、设置类注释模板这样在定义类时,都要多输入类的描述。不想的话,可以删去 ${description}2、方法注释模板先新建模板组,名字自己起。然后选中自己的模板组,在模板组下...
1 2 3 4 5 ... 20
收藏数 1,653,793
精华内容 661,517
关键字:

注释