关于java命名规范及注释,并将javadoc的生成html

一、包的命名都是小写 ,域名的倒置

二、类的命名 有意义 ,所有单词首字母大写,方法的话,动词,有意义,首字母小写,第二个单词开始首字母大写。

三、变量的命名一般是名词,首字母小写,第二个单词首字母大写,

四、常量的命名,单词中的所有字母都大写,常量单词的分割使用下划线。

注释分为单行注释//,多行注释/* */及javadoc注释

javadoc注释是在类名前面和方法前面输入/*回车,类注释写一下简单实现的功能 ,方法注释写上参数及方法返回值

在java接口中的注释,在实现类中,将鼠标移到方法名上,会显示注释,如图



java项目的代码文档的生成

项目右键Export  搜索 javadoc 点下一步,并在javadoc command中选择jdk下面的bin目录下的javadoc.exe,选择输出路径,并生成,最终在生成目录打开index.html可查看


生成结果如下



  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值