Java中生成帮助文档
2024-09-04 01:28:06
如何在Java中使用注释
在编写程序时,经常需要添加一些注释,用以描述某段代码的作用。
一般来说,对于一份规范的程序源代码而言,注释应该占到源代码的 1/3 以上。因此,注释是程序源代码的重要组成部分,一定要加以重视哦!
Java 中注释有三种类型:单行注释、多行注释、文档注释
运行结果: Hello Imooc!
看:被注释的代码块在程序运行时是不会被执行的~~
我们可以通过 javadoc 命令从文档注释中提取内容,生成程序的 API 帮助文档。
打开首页,查看下生成的 API 文档
PS:使用文档注释时还可以使用 javadoc 标记,生成更详细的文档信息:
@author 标明开发该类模块的作者
@version 标明该类模块的版本
@see 参考转向,也就是相关主题
@param 对方法中某参数的说明
@return 对方法返回值的说明
@exception 对方法可能抛出的异常进行说明
最新文章
- LOL(英雄联盟)提示不支持虚拟机登录,解决方法
- ecshop二次开发常用文件位置
- ios6 滤镜相关知识内容网址
- Python 6 —— 异常
- String相关操作
- MVC - 基础
- PHP函数参数的引用传递和值传递
- javascript(五)验证
- 于Eclipse传导C/C++配置方法开发(20140721新)
- S3C2440硬件IIC详解
- 【java】关于java类和对象,你想知道的在这里!
- 机器学习--kNN算法识别手写字母
- [bzoj4771] 七彩树
- koa2学习笔记
- G - Intersecting Rectangles Kattis - intersectingrectangles (扫描线)(判断多个矩形相交)
- windows nginx配置https访问
- 关于c#连接数据库的代码
- Kubernetes1.91(K8s)安装部署过程(八)-- kubernetes-dashboard安装
- k8s之使用secret获取私有仓库镜像
- MFC中查找替换对话框CFindReplaceDialog类
热门文章
- SQL语句之用户管理
- ifconfig无输出的原因及解决办法
- 实现微信小程序支付
- 解决js array的key不为数字时获取长度的问题
- 换个角度看Salesforce之基础配置学习笔记(一)
- Python学习 day10
- 问题记录——com.mysql.jdbc.exceptions.jdbc4.CommunicationsException: Communications link failure
- [原]SuperMap GIS(JavaScript) 拉框放大和缩小功能实现
- (转)python collections模块详解
- 基于Metronic4.1的Bootstrap脚本样式说明