文档介绍：1 / 12
代码开发规
对于新增代码或者修改的代码应按代码规要求进行编写。
一、通用规
Kconfig文件:
格式：注释部分以#开头,空一格开始写注释容。
一级容"config"顶头开始
二级容开头空白处为一个制表符
* Chris Vance, <cvancenai.>
*
□*□□Copyright <C> 2001,2002 Networks Associates Technology, Inc.
□*□□Copyright <C> 2004-2005 Trusted Computer Solutions, Inc.
□* <dgoeddeltrustedcs.>
*
□*□□This program is free software; you can redistribute it and/or
□*□□modify it under the terms of the GNU General Public License
□*□□version 2,as published by the Free Software Foundation.
□*/
新增或修改的代码重要部分可以添加注释。代码注释统一用’/*’和’*/’整块注释,注释容与’*’间用空格隔开,若注释是多行,则采用类似首部注释的格式,每行注释前面都有一个’*’。
函数定义注释
注释可选项目：函数说明／参数信息／返回值信息／使用信息
对一个函数的注释,每项初始位置缩进要一致；可以缩进一个空格的或几个空格,核代码一般缩进一个制表符。注释项分段时段与段间空一行,如下图所示为函数iunique的注释,‘□’代表空格：
4 / 12
/**
□*□□□□□□remove_inode_hash - remove an inode from the hash
□*□□□□□□inode: inode to unhash
□*
□*□□□□□□Remove an inode from the superblock.
□*/
void remove_inode_hash<struct inode *inode>
{……}
/*
□*□> 0 if the file is in use
□*□= 0 if the file is not in use
□*□< 0 on failure
□*/
asmlinkage long sys_fcount<int op, void __user *data>
{……}
<2>代码块与单语句注释
对整块代码进行的注释放在整块代码前面,如对函数说明注释放在函数定义前面一行；注释与被注释代码的缩进保持一致；对单独一条语句的注释可以放在语句后面,同一性质的注释最好保持对齐。
#include <linux/> /* for Unix socket types */
……
5 / 12
if <dname_external<dentry>> {
□□□□□□□□/*
□□□□□□□□* Both external: swap the pointers
□□□□□□□□*/
□□□□□□□□do_switch<target->, dentry->> ;
} else {
□□□□□□□□/*
□□□□□□□□* dentry:internal, target:external. Steal target's
□□□□□□□□* storage and make target internal.
□□□□□□□□*/
□□□□□□□□dentry-> = target->;
□□□□□□□□target-> = target->d_iname;
}
空行：
代码块与代码块间至少空一行,同一类型的代码在不影响功能的情况下最好放在一块。如include语句,包含库文件中的头文件放在一起,包含非库文件的头文件放在一起,两部分中间空一行；不同函数定义间空一行。
在函数,简单变量声明放在一起,与其他语句间空行,复杂的变量如结构体、枚举类型的定义须占用多行时,单独作为一块,后面空一行；一般if语句、while语句、for语句等这些基本c语言语句类型后空一行,这些语句中嵌套的语句建议后面也空一行。
goto语句