首页 > 学院 > 开发设计 > 正文

自认为不错的注释习惯

2019-11-08 03:18:58
字体:
来源:转载
供稿:网友

本人主攻java和c,所以按照这两个语言的注释方法,总结了几个不错的注释习惯

一、负责人签名

在文件开头一定写上创建的日期(甚至是时间),自己的姓名,这个文件主要是写什么的,就是功能。

/*(后面为空)

(一个空格) *(一个空格)时间:1897/13/32

(一个空格) *(一个空格)姓名:一个有梦想的码农

(一个空格) *

(一个空格) *

(一个空格) */(后面为空)

(空行)

样例:

/* * 时间:1897/13/32 * 姓名:一个有梦想的码农 * ****:******** */
大家可以在自己的编译器中看一看,很漂亮。在最后有一个空行,根据个人习惯吧,我喜欢加上一个空行,有结构感

二、注释中表格的画法

        在注释中很少使用到表格,但是一旦注释量大的时候,传统注释就会感觉很乱,而表格可以是整个页面变得清爽。

/*

 * +------------------------------------------------+--------------------------------------------------+---------------------------------------------------+

 * +(一个空格)A1(至少一个空格)         +(一个空格)A2(至少一个空格)           +(一个空格)A3(至少一个空格)             +

 * +------------------------------------------------+--------------------------------------------------+---------------------------------------------------+

 * +(一个空格)B1(至少一个空格)         +(一个空格)B2(至少一个空格)           +(一个空格)B3(至少一个空格)            +

 * +------------------------------------------------+--------------------------------------------------+---------------------------------------------------+

 * +(一个空格)C1(至少一个空格)         +(一个空格)C2(至少一个空格)           +(一个空格)C3(至少一个空格)           +

 * +------------------------------------------------+--------------------------------------------------+---------------------------------------------------+

 */

大家可以在编译器中看看,挺好看的

样例:

/* * +----------+-----------------+ * + date     + 2016/11/12      + * +----------+-----------------+ * + name     + aaaaa           + * +----------+-----------------+ */


发表评论 共有条评论
用户名: 密码:
验证码: 匿名发表