java编程规范-注释
来源:互联网 发布:丁红玉的淘宝店 编辑:程序博客网 时间:2024/05/17 22:09
注释
对于方法内部用throw语句抛出的异常,必须在方法的注释中标明,对于所调用的其他方法所抛出的异常,选择主要的在注释中说明。对于非RuntimeException,即throws子句声明会抛出的异常,必须在方法的注释中标明。(1.42+)
说明:异常注释用@exception或@throws表示,在JavaDoc中两者等价,但推荐用@exception标注Runtime异常,@throws标注非Runtime异常。异常的注释必须说明该异常的含义及什么条件下抛出该异常。
避免在注释中使用缩写,特别是不常用缩写。(1.42+)
说明:在使用缩写时或之前,应对缩写进行必要的说明。
对重载父类的方法必须进行@Override声明(5.0+)
说明:可清楚说明此方法是重载父类的方法,保证重载父类的方法时不会因为单词写错而造成错误(写错方法名或者参数个数,类型都会编译无法通过)
示例:
@Override
public void doRequest(SipServletRequest req) throws ServletException,
IOException
- java编程规范-注释
- java编程规范之java注释规范
- java编程的注释规范
- 【规范】编程注释规范
- 编程规范——Java注释样式规范与模板
- 编程之注释规范
- 编程规范 --- 注释
- java注释规范
- Java注释规范
- Java注释规范
- java 注释规范
- Java注释规范
- Java 注释规范
- Java注释规范
- Java注释规范
- java注释规范
- java注释规范
- java注释规范
- PCI子系统之-resource插入算法
- 各种渗透,提权的经验和技巧总结(下)
- 记录自己用到的tcpdump命令
- c++ extra qualification
- 用rand()实现bigrand()和randint(l,u)
- java编程规范-注释
- redis 配置说明
- 常用 mysql函数查询
- linux 挂载分区后里面c c++可执行文件不能执行问题
- 各种渗透,提权的经验和技巧总结(中)
- [IT 男人帮 -- 15 Jan] 传百度洽谈控股金山网络对抗360 360股价大跌4%
- 各种渗透,提权的经验和技巧总结(上)
- Mysql 複雜查詢或關係語句的書寫
- SharePoint中显示附件(1),DataView显示附件的一个解决办法