栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > Java

Java的文档注释

Java 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

Java的文档注释

这一段时间在看Java源码以及别人的一些代码时总会看到一些用 @ 修饰的东西。以前最熟悉的就是@override重写,但当我看到这个

真的可以说是被“震惊”了,所以打算来学习一下Java的文档注释。


Java 支持三种注释方式。前两种分别是 // 和 ,第三种被称作说明注释,它以 **结束,前两种都是都是非常熟悉的了,最有意思的是第三种说明注释。

Java标签

这里只列举几个常见的Java标签

标签描述示例
@author标识一个类的作者@author description
@return说明返回值类型@return exp
@param说明一个方法的参数@param parameter-name exp
@exception标志一个类抛出的异常@exception exception-name exp
@throws和 @exception标签一样同上
@serial说明一个序列化属性@serial description
Java的文档注释

在开始的 public interface OrderInterface { List pageList(int a, int b); int pageCount(); List pageListById(int id); List pageListDate(String d1, String d2); List pageListMenu(String name); int updateDeliveryById(Integer id); int deleteById(Integer id); List pageListByDelivery(Integer delivery); int insert(Orders orders); // 增加order }

利用


JavaDoc给的注释确实实用,但我们每次用起来还是会特别的麻烦,其实我们可以自定义成模板在 IDE 上,这样每次通过快捷键就可自动帮你输出在方法中,省去了很多时间,也使代码更加规范。

如何自定义模板?可以参考这几篇博客:

  • IDEA工具第二篇:自定义Java注释模板
  • IDEA中如何自定义注释模板
转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/877857.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号