JAVA学习笔记——Javadoc的基本使用

一.Javadoc简介

javadoc是Sun公司提供的一个技术,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说,只要在编写程序时以一套特定的标签作注释,在程序编写完成后,通过Javadoc就可以同时形成程序的API文档了。


二.Javadoc规范

Javadoc一般写在类和方法的上面,用于解释类和方法的作用

通常Javadoc分为三段:

1.概述类或方法的作用
2.详细描述类或方法的作用,可以使用HTML标签,一般以< p >开始
3.文档标注,在类上标注作者、参阅类、创建时间等,在方法上标注参数、返回值、异常等

Javadoc中还有一系列定义好的文档标记:

源自百度百科
源自百度百科


三.简单示例

/**
*概述
*
*<p>
*详细描述
*更多详细的描述
*
*@param 参数名 描述
*@return 描述
*/

引用

百度百科

javadoc

CSDN

javadoc使用详解


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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值