8.20java学习

时间:2021-08-20
本文章向大家介绍8.20java学习,主要包括8.20java学习使用实例、应用技巧、基本知识点总结和需要注意事项,具有一定的参考价值,需要的朋友可以参考一下。

今天学习了源代码的注释规范

源代码注释的规范
【规范 1】文件注释
文件注释用予说明代码文件的一些附加信息,它位于源代码文件的顶部。文件
注释最重要的作用是记录代码维护历史。
文件注释示例:
/*
*文件名:Demo.cpp
*作者:t02011688 刘立嘉
*完成日期:2021/08/01
*文件内容说明:本文件包括了搜索遍历的算法
*当前版本:1.0
*/
【规范 2】类注释
类的注释位于类声明的前面,使用 /* */进行注释(对于 java,是/** */)。
类的注释应该说明以下几点:
(1)完成了哪些工作,即这个类是做什么的。
(2)使用的方法和注意事项,如果比较难以表达,那么可以写一些示例代码。
(3)作者列表。
(4)当前版本和完成时间。
(5)参考类,即这个类与那些类相关。
注意:类注释不要写类的实现方法,如 Matrix 类采用主选消元法实现矩阵的求
逆运算......
类注释示例:/*
*类的作用:CStudent 类定义了学生类。
*类的使用:CStudent cstuA;
*作者:t02011688 刘立嘉
*当前版本及完成时间:ver 1.01,2021.8.1
*参考类:公有继承自 CPeople 类
*/
【规范 3】方法注释。
方法注释位于方法(函数、过程)的前面 ,使用/**/进行注释,方法注释应该
说明以下几点:
(1)方法的作用与使用注意事项。
(2)对每一个输入参数讲行说明:作用,取值范围等。
(3)对返回值进行说明。
(4)方法注释不要写算法。
方法注释示例:
/*
*方法作用:int add(int a,int b)方法返回两个整数 a 和 b 的和
*输入参数:加数 a(int),加数 b(int)
*返回值:加数 a 和 b 的和(int)
*/
【规范 4】方法/函数内的注释
(1)为重要的变量定义进行行注释,说明作用和取值范围
int iCount=0;
//计数器,表示搜索到记录的总数,>=0(2)复杂算法的代码块或复杂的逻辑结构代码块的注释说明:
示例:
/*以下代码采用二分法对链表进行排序,具体算法是
*/
在对应的复杂算法的代码块或复杂的逻辑结构代码块结束后应有空行示意结束

原文地址:https://www.cnblogs.com/lhydbk/p/15168248.html