JAVA基础(4)---JAVA注释及javadoc

本文详细介绍了Java中的三种注释类型:单行注释、多行注释和文档注释,强调了文档注释在生成API文档中的作用。通过使用javadoc命令,可以将这些注释转换为HTML格式的文档,便于团队成员理解和维护代码。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

java中的注释:

    三种注释:   // 称为单行注释 

             /*
                         多行注释
                        */


                        /**
                       文档注释
                       @author 标明开发该类模块的作者
                       @version 标明该类模块的版本
                       @param 对方法中某参数的说明
                       @return 对方法返回值的说明
                       @exception 对方法可能抛出的异常进行说明
                       */
        文档注释:我们可以使用javadoc命令来生成当前程序的说明文档,是HTML格式


       cmd生成语句:javadoc -d doc HelloWorld.java
                -d doc指定生成的帮助文档的位置
                HelloWorld.java要对哪一个Java文件生成帮助文档

注释,也是我们Java程序的一个重要组成部分,它能提高代码的可读性。

Java代码的规范:

    对于开发过程中的代码书写一定要规范:
        1 代码一定要有层次
        2 代码的不同部分之间要有一定的缩进来进行区分
        3在写代码的过程中,先写格式,再填充内容。可以保证我们的代码不会应为缺少符号({} () ;等问题而出错)
   

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值