java的三种代码注释方式「建议收藏」

java的三种代码注释方式「建议收藏」1.注释的作用注释是对程序语言的说明,有助于开发者之间的交流,方便理解和维护程序。注释不是编程语句,不会被编译器执行。一些代码量少较少的程序,我们加不加注释对我们的理解和修改代码没有太大影响;如果是淘宝;抖音等那种中大型程序,没有了代码注释,对于日后程序运行维护将是很大困难。我们可以在平时编码过程中养成规范代码注释习惯,也是我们成为优秀程序员的原因2.java中的注释分类Java中的注释分为以下三种:单行注释;多行注释;文档注释1.单行注释java代码中使用双斜杠单行注释//,一般单行注释,注释少

大家好,又见面了,我是你们的朋友全栈君。

1.注释的作用

注释是对程序语言的说明,有助于开发者之间的交流,方便理解和维护程序。注释不是编程语句,不会被编译器执行。一些代码量少较少的程序,我们加不加注释对我们的理解和修改代码没有太大影响;如果是淘宝;抖音等那种中大型程序,没有了代码注释,对于日后程序运行维护将是很大困难。我们可以在平时编码过程中养成规范代码注释习惯,也是我们成为优秀程序员的原因

2.java中的注释分类

Java中的注释分为以下三种:单行注释;多行注释;文档注释

1.单行注释

java代码中使用双斜杠单行注释//,一般单行注释,注释少量代码或者说明内容 ,格式为:

// 单行注释

2.多行注释

java代码中使用多行注释/* */,一般使用多行注释大量的代码或者说明内容 ,格式为:

/*

多行注释

多行注释

*/

3.文档注释

使用文档注释/** */,文档注释一般用于对类和方法进行功能说明 ,说明类的编写时间和作者以及方法作用参数和返回值

3.1类上的注释

/** * 类上的文档注释 * @author 张三 * @version 1.10.0 */

3.2方法上的注释

/** * 方法前的文档注释 * @param * @return * @throws */
标签 描述
@author 标识一个类的作者
@version 版本号
@since 当前文件使用jdk版本
@return 说明方法返回值类型
@param 说明一个方法的参数
@throws 抛出的异常
版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请联系我们举报,一经查实,本站将立刻删除。

发布者:全栈程序员-站长,转载请注明出处:https://javaforall.net/156322.html原文链接:https://javaforall.net

(0)
全栈程序员-站长的头像全栈程序员-站长


相关推荐

  • inputstreamreader和outputstreamwriter_input string

    inputstreamreader和outputstreamwriter_input string1.转换流原理2.OutputStreamWriterjava.io.OutputStreamWriterextendsWriterOutputStreamWriter:是字符流通向字节流的桥梁;可使用指定的charset将要写入流中的字符编码成字节。(编码:把能看懂的变成看不懂)2.1继承自父类的共性成员方法:voidwrite(intc)写入单个字符voidwrite(char[]cbuf)写入字符数组abstractvoidwrite(char[]cu

    2022年9月11日
    3
  • 新一代金融神话Filecoin[通俗易懂]

    新一代金融神话Filecoin[通俗易懂]Filecoin是区块链史上耗时最短的ICO融资项目,受到了DCG集团、文克莱沃斯兄弟基金会、联合广场风投、AndersonHollotz基金和红杉资本等投资巨头的青睐。储存即收益,Filecoin与BTC的工作证明是不同的。filecoin只需要提供存储空间和宽带,就可以满足获取身份证明的需求。因此,Filecoin可以从根本上提高人类的效率,是一种真正的共享经济,它可以极大地推动存储资源的使用方式。由于Filecoin是基于强大的IPFS协议,并且由于IPFS的大量应用,Filecoin作为IPFS

    2022年9月12日
    2
  • idea部署tomcat启动浏览器显示404(如何部署tomcat)

    之前按照网站教程https://www.cnblogs.com/cangqinglang/p/10027199.html配置IDEA之后,tomcat启动成功,但是访问页面报404错误,参考了网站各种教程也没有解决,最后同事发现是outputdirectory路径配置错误了,一定要让项目的输出路径为tomcat的webapps路径,而不能是项目路径,坑了我半天时间,找这个问题,在此贴出来…

    2022年4月11日
    82
  • TextMate介绍[通俗易懂]

    TextMate介绍[通俗易懂]Mac平台非常著名的文本/代码编辑器TextMate宣布开源,源代码已经托管到GitHub网站,同时公布了完整的编译方法。https://github.com/textmate/text

    2022年7月4日
    26
  • xfire框架内部基本结构解析

    xfire框架内部基本结构解析1概述xfire是webservice的一个实现框架,是apache旗下CXF的前身,是一个比较被广泛使用的webservice框架,网上有很多关于如何使用xfire或cxf的helloworld

    2022年7月1日
    21
  • windows如何远程centos桌面_windows远程桌面命令

    windows如何远程centos桌面_windows远程桌面命令作者:【吴业亮】云计算开发工程师博客:http://blog.csdn.net/wylfengyujiancheng前提:CentOS安装桌面,如果无桌面,请执行#yum-ygroupsinstall”GNOMEDesktop”#startx配置源#yuminstallepel*-y安装xrdp#yum–enablerepo=epel-yinst…

    2022年9月6日
    4

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注

关注全栈程序员社区公众号