怎样按照crud原则补齐接口源文件以注释的形式说明
1、保障型保险
保障性保险属于人寿保险行业的行话,其最大的特点就是保障高,费用低廉,跟消费型保险属同一个性质,比如险种有意外险,定期寿险等等。健康型保险,也属于保障型险种一类。
一般是于储蓄型险种,有较大区别,其特点是有一定的返还和到期的退费等,对应的是保费较高,如养老险、教育险等。
2、健康险
健康险与一般寿险是保险产品中销售量比较高的两种险种
健康险是以疾病的发病率和意外伤害事故的发生率为保险费计算的基础。健康险的保险事故是指患病和意外伤害,而非死亡,不像其他寿险那样以生命表为确定保险费费率的基础。因此,健康险的费率是经验费率,而非一般寿险有固定生命表可查。
健康险的保险事故是指患病、意外伤害等,人的疾病有多种,健康险的险种也有许多不同类型,对各种疾病、各年龄层次均可组合,每一险种都有一定的客户群,险种多的,争取到的客户就多,尤其是某些发生率低,但一旦发生,大多数家庭均难以负担其医疗费用的保险,更具有费率低,保障高的特点。而一般寿险的险种仅仅是生存领取和死亡给付的组合,险种少。
纯保障型险种就是没有分红功能的险种,只有保障,没有分红功能。
C语言编程规范-注释规则:
1:一般情况下,源程序有效注释量必须在20%以上。
说明:注释的原则是有助于对程序的阅读理解,在该加的地方都加了,注释不宜太多也不能太少,注释语言必须准确、易懂、简洁。
2:说明性文件(如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等)头部应进行注释,注释必须列出:版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等,头文件的注释中还应有函数功能简要说明。
示例:下面这段头文件的头注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。
/*************************************************
Copyright (C), 1988-1999, Tech. Co., Ltd.
File name: // 文件名
Author:
Version:
Date: // 作者、版本及完成日期
Description: // 用于详细说明此程序文件完成的主要功能,与其他模块
// 或函数的接口,输出值、取值范围、含义及参数间的控
// 制、顺序、独立或依赖等关系
Others: // 其它内容的说明
Function List: // 主要函数列表,每条记录应包括函数名及功能简要说明
1. ....
History: // 修改历史记录列表,每条修改记录应包括修改日期、修改
// 者及修改内容简述
1. Date:
Author:
Modification:
2. ...
*************************************************/
3:源文件头部应进行注释,列出:版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。
示例:下面这段源文件的头注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。
/************************************************************
Copyright (C), 1988-1999, Tech. Co., Ltd.
FileName: test.cpp
Author:
Version :
Date:
Description: // 模块描述
Version: // 版本信息
Function List: // 主要函数及其功能
1. -------
History: // 历史修改记录
<author> <time> <version > <desc>
David 96/10/12 1.0 build this moudle
***********************************************************/
说明:Description一项描述本文件的内容、功能、内部各部分之间的关系及本文件与其它文件关系等。History是修改历史记录列表,每条修改记录应包括修改日期、修改者及修改内容简述。
4:函数头部应进行注释,列出:函数的目的/功能、输入参数、输出参数、返回值、调用关系(函数、表)等。
示例:下面这段函数的注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。
/*************************************************
Function: // 函数名称
Description: // 函数功能、性能等的描述
Calls: // 被本函数调用的函数清单
Called By: // 调用本函数的函数清单
Table Accessed: // 被访问的表(此项仅对于牵扯到数据库操作的程序)
Table Updated: // 被修改的表(此项仅对于牵扯到数据库操作的程序)
Input: // 输入参数说明,包括每个参数的作
// 用、取值说明及参数间关系。
Output: // 对输出参数的说明。
Return: // 函数返回值的说明
Others: // 其它说明
*************************************************/
5:边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。不再有用的注释要删除。
6:注释的内容要清楚、明了,含义准确,防止注释二义性。
说明:错误的注释不但无益反而有害。
7:避免在注释中使用缩写,特别是非常用缩写。
说明:在使用缩写时或之前,应对缩写进行必要的说明。
8:注释应与其描述的代码相近,对代码的注释应放在其上方或右方(对单条语句的注释)相邻位置,不可放在下面,如放于上方则需与其上面的代码用空行隔开。
示例:如下例子不符合规范。
例1:
/* get replicate sub system index and net indicator */
repssn_ind = ssn_data[index].repssn_index;
repssn_ni = ssn_data[index].ni;
例2:
repssn_ind = ssn_data[index].repssn_index;
repssn_ni = ssn_data[index].ni;
/* get replicate sub system index and net indicator */
应如下书写
/* get replicate sub system index and net indicator */
repssn_ind = ssn_data[index].repssn_index;
repssn_ni = ssn_data[index].ni;
9:对于所有有物理含义的变量、常量,如果其命名不是充分自注释的,在声明时都必须加以注释,说明其物理含义。变量、常量、宏的注释应放在其上方相邻位置或右方。
示例:
/* active statistic task number */
#define MAX_ACT_TASK_NUMBER 1000
#define MAX_ACT_TASK_NUMBER 1000 /* active statistic task number */
10:数据结构声明(包括数组、结构、类、枚举等),如果其命名不是充分自注释的,必须加以注释。对数据结构的注释应放在其上方相邻位置,不可放在下面;对结构中的每个域的注释放在此域的右方。
示例:可按如下形式说明枚举/数据/联合结构。
/* sccp interface with sccp user primitive message name */
enum SCCP_USER_PRIMITIVE
{
N_UNITDATA_IND, /* sccp notify sccp user unit data come */
N_NOTICE_IND, /* sccp notify user the No.7 network can not */
/* transmission this message */
N_UNITDATA_REQ, /* sccp user's unit data transmission request*/
};
11:全局变量要有较详细的注释,包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。
示例:
/* The ErrorCode when SCCP translate */
/* Global Title failure, as follows */ // 变量作用、含义
/* 0 - SUCCESS 1 - GT Table error */
/* 2 - GT error Others - no use */ // 变量取值范围
/* only function SCCPTranslate() in */
/* this modual can modify it, and other */
/* module can visit it through call */
/* the function GetGTTransErrorCode() */ // 使用方法
BYTE g_GTTranErrorCode;
12:注释与所描述内容进行同样的缩排。
说明:可使程序排版整齐,并方便注释的阅读与理解。
示例:如下例子,排版不整齐,阅读稍感不方便。
void example_fun( void )
{
/* code one comments */
CodeBlock One
/* code two comments */
CodeBlock Two
}
应改为如下布局。
void example_fun( void )
{
/* code one comments */
CodeBlock One
/* code two comments */
CodeBlock Two
}
13:将注释与其上面的代码用空行隔开。
示例:如下例子,显得代码过于紧凑。
/* code one comments */
program code one
/* code two comments */
program code two
应如下书写
/* code one comments */
program code one
/* code two comments */
program code two
14:对变量的定义和分支语句(条件分支、循环语句等)必须编写注释。
说明:这些语句往往是程序实现某一特定功能的关键,对于维护人员来说,良好的注释帮助更好的理解程序,有时甚至优于看设计文档。
15:对于switch语句下的case语句,如果因为特殊情况需要处理完一个case后进入下一个case处理,必须在该case语句处理完、下一个case语句前加上明确的注释。
说明:这样比较清楚程序编写者的意图,有效防止无故遗漏break语句。
示例(注意斜体加粗部分):
case CMD_UP:
ProcessUp();
break;
case CMD_DOWN:
ProcessDown();
break;
case CMD_FWD:
ProcessFwd();
if (...)
{
...
break;
}
else
{
ProcessCFW_B(); // now jump into case CMD_A
}
case CMD_A:
ProcessA();
break;
case CMD_B:
ProcessB();
break;
case CMD_C:
ProcessC();
break;
case CMD_D:
ProcessD();
break;
...
建议:
1:避免在一行代码或表达式的中间插入注释。
说明:除非必要,不应在代码或表达中间插入注释,否则容易使代码可理解性变差。
2:通过对函数或过程、变量、结构等正确的命名以及合理地组织代码的结构,使代码成为自注释的。
说明:清晰准确的函数、变量等的命名,可增加代码可读性,并减少不必要的注释。
3:在代码的功能、意图层次上进行注释,提供有用、额外的信息。
说明:注释的目的是解释代码的目的、功能和采用的方法,提供代码以外的信息,帮助读者理解代码,防止没必要的重复注释信息。
示例:如下注释意义不大。
/* if receive_flag is TRUE */
if (receive_flag)
而如下的注释则给出了额外有用的信息。
/* if mtp receive a message from links */
if (receive_flag)
4:在程序块的结束行右方加注释标记,以表明某程序块的结束。
说明:当代码段较长,特别是多重嵌套时,这样做可以使代码更清晰,更便于阅读。
示例:参见如下例子。
if (...)
{
// program code
while (index < MAX_INDEX)
{
// program code
} /* end of while (index < MAX_INDEX) */ // 指明该条while语句结束
} /* end of if (...)*/ // 指明是哪条if语句结束
5:注释格式尽量统一,建议使用"/* …… */"。
6:注释应考虑程序易读及外观排版的因素,使用的语言若是中、英兼有的,建议多使用中文,除非能用非常流利准确的英文表达。
说明:注释语言不统一,影响程序易读性和外观排版,出于对维护人员的考虑,建议使用中文。
怎样按照crud原则补齐接口源文件以注释的形式说明
1:一般情况下,源程序有效注释量必须在20%以上。说明:注释的原则是有助于对程序的阅读理解,在该加的地方都加了,注释不宜太多也不能太少,注释语言必须准确、易懂、简洁。2:说明性文件(如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等)头部应进行注释,注释必须列出:版权说明、版本号、生成日期、作者、...
REST软件架构的REST与CRUD(资源操作)
REST软件架构使用了CRUD原则,该原则告诉我们对于资源(包括网络资源)只需要四种行为:创建(Create)、获取(Read)、更新(Update)和销毁(DELETE),就可以组合成其他无数的操作。其实世界万物都是遵循这一规律:生、变、见、灭。这个原则是源自于我们对于数据库表的数据操作:insert(生)、select(见...
webservice和restful的区别
REST 与缓存服务器 (Cache Server)使用 HTTP 协议的 SOAP,由于其设计原则上并不像 REST 那样强调与 Web 的工作方式相一致,所以,基于 SOAP 应用很难充分发挥 HTTP 本身的缓存能力,图 7. SOAP 与缓存服务器 (Cache Server)总结:REST对于资源型服务接口来说很合适,同时特别适合对于效率要求很高,但...
说明固体为什么仅由电子极化决定折射率
研究人员已经设计出一种实用的解决方案,用于防止核系统中的腐蚀累积。图像显示了带有和不带有我们耐CRUD涂层的标准反应堆锆合金的样品。在我们流动的反应堆实验中,左侧未镀膜的样品被CRUD覆盖,而两个镀膜的样品在进入时就干净了。当木塞和腐蚀威胁到住宅的供水和供暖系统时,房主可以简单地打电话给水管...
REST webservice与普通的servlet有什么不同
发布自己的web服务,吸引更多的开发者加入他们的阵营。Rest除了满足基本的CRUD 设计原则之外,还要遵循如下约定:1. 资源操作可以通过描述来实现即Representation 2. 消息本身是无状态与自我描述(传输支持XML与JSON)3. 可以发送与接受多个Representation Rest风格(Restful Style)架构原则:1. 客户...
什么是好的API与设计流程和设计原则
CRUD四个类别对于操作资源来说,绝大多数情况下是完备的。HTTP的GET\/POST\/PUT\/DELETE四个方法,对于CRUD四个类别的操作来说是足够的,映射关系是Create-POST\/Retrieve-GET\/Update-PUT\/Delete-DELETE。我们通常不会选择创建自己的动词,这样做对于客户端开发者来说,需要更多的学习成本。如果在资源上定义的操作过多,我们...
JPA是什么?
框架据此将实现对象持久化到数据库表中。Java持久化API用来操作实体对象,执行CRUD操作,框架在后台替我们完成所有的事情,开发者可以从繁琐的JDBC和SQL代码中解脱出来。查询语言这是持久化操作中很重要的一个方面,通过面向对象而非面向数据库的查询语言查询数据,避免程序的SQL语句紧密耦合 ...
简历上的项目描述(JAVA)怎么写
表示层运用了G架构,使用H作为视图I作为控制器并实现了REST风格的请求;业务逻辑层运用了J模式,并通过K实现事务、日志和安全性等功能,通过L实现缓存服务;持久层使用了M封装CRUD操作,底层使用N实现数据存取。整个项目采用了P开发模型。 说明:上面的描述中,E通常指Spring(Java企业级开发的一站式选择);F最有可能是...
应该怎样学习JAVA?顺序是什么?
第一部分:JavaSE:Java语言最基本的一套库 学习JavaEE或JavaME之前,JavaSE是必学的。Java开发环境搭建 Java基础语法 面向对象 数组 异常 集合 线程 IO流 反射机制 注解Annotation 网络编程 第二部分:数据库 【MySQL + JDBC】只要学习编程,数据库是一定要学习的,是一门公共的学科。java、C、python...
类琪益气: 您好,您这样:package com.tgb.lk.demo.model; import com.tgb.lk.ahibernate.annotation.Column; import com.tgb.lk.ahibernate.annotation.Id; //此处没有加Table属性,它是其他类的基类,本类中用@Column注解的字段在子类中同样会被创建到...
赤峰市18087631915: java web 评论及回复系统 - ?
类琪益气: ssh -数据库 设计多对一 多条评论对应一条记录 bean 会写吧dao 抽象类封装crudimpl 实现crud service调用dao的方法action就很简单了,只需要处理请求注意的是要会写配置文件...
赤峰市18087631915: 搭建Springboot,引入接口CrudRepository后启动报错,找不出原因,不引就没问题. - ?
类琪益气: 这个原因是maven依赖包冲突,有重复的依赖. 检查一下你引入的jar包里面是不是有相同的方法名.
赤峰市18087631915: 继承jparepository的接口怎么注入 - ?
类琪益气: 了Repository Bean所在的位置,在这个包下的所有的继承了Repository的接口都会被IOC容器识别并纳入到容器中,如果没有继承Repository则IOC容器无法识别.3.我们也可以通过注解的方式替代继承Repository接口@RepositoryDefinition(...
赤峰市18087631915: C++中,头文件与源文件分别有什么作用? - ?
类琪益气: 一般来说,头文件提供接口,源文件提供实现.但是有些实现比较简单的,也可以直接写在头文件里,这样头文件接口实现一起提供.在编译时,源文件里的实现会被编译成临时文件,运行时刻程序找到头文件里的接口,根据接口找到这些临时文件,来调用它们这些实现.
赤峰市18087631915: Hibernate中Session只是一个接口,它是怎么进行数据? ?
类琪益气: 是通过动态代理对象来实现类,Hibernate 已经封装好了的,就是因为这个动态代理对象出现了load()和get()的区别---赖加载. 希望我的回答能给你帮助.
赤峰市18087631915: linux 中,gcc - c 产生目标代码, - o连接文件.其实很多时候直接 - o就可以了,为什么要 - c呢? - ?
类琪益气: -o 表示产生目标文件.-c 表示只编译代码但不进行链接,加改参数生成的目标文件是不能执行的(我们常用的链接库就是这样得来的).通常在只有一个源文件的情况下不需要加-c.但实际上大多数情况下C程序远不止1个源文件,当main函数需要调用不在同一源文件下的函数时就需要链接到包含该函数的目标文件.举个例子:/*main.c*/#include int main(){ test(); }/*test.c*/#include extern void test(){ } 编译步骤: gcc -c test.c -o test gcc test main.c -o main
赤峰市18087631915: Java中一个关于接口和包的小问题 - ?
类琪益气: D,默认情况下,接口中的成员方法具有"public abstract"所联合规定的属性.同样,public在这里不可改变,abstract没有可以替代的关键字,又由于abstract和static不可联合使用,所以不要能是静态方法,而构造方法不可能为抽象方法,故没有构造构造方法,故所有的方法都具有public访问权限的抽象实例方法. A,如果公共的接口声明在一个源文件中,则这个源文件就必须实现这个公共接口中所有的抽象方法,而当N多类来调用这个接口的方法的时候,就可以直接通过接口名.方法名来调用!