代码规范说明.doc

《代码规范说明.doc》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、代码开发规对于新增代码或者修改的代码应按代码规要求进行编写。一、通用规1.1Kconfig文件:格式：注释部分以#开头,空一格开始写注释容。一级容“config”顶头开始二级容开头空白处为一个制表符，相当于8个空格三级容开头空白处为一个制表符再加两个空格，即比二级容缩进两个空格容：help说明部分必须有，为第三级容，需说明帮助信息，分段的容需空一行，每块config间空一行。以文件系统fs下的Kconfig示例如下图1.1,‘□’代表一个空格，短横线‘－’所占一行代表一个空行:图1.1##□Filesystemconfiguration#

2、----------------------------------------------------------------menu"Filesystems"----------------------------------------------------------------configEXT2_FS□□□□□□□□tristate"Secondextendedfssupport"□□□□□□□□help□□□□□□□□□□Ext2isastandardLinuxfilesystemforharddisks.□□□□□□□□

3、□□Tocompilethisfilesystemsupportasamodule,choose□□□□□□□□□□Mhere:themodulewillbecalledext2.Beaware□□□□□□□□□□howeverthatthefilesystemofyourrootpartition□□□□□□□□□□(theonecontainingthedirectory/)cannotbecompiled□□□□□□□□□□asamodule,andsothiscouldbedangerous.-------------------

4、---------------------------------------------□□□□□□□□□□Ifunsure,sayY.-----------------------------------------------------------------configEXT2_FS_XATTR□□□□□□□□bool"Ext2extendedattributes"□□□□□□□□dependsonEXT2_FS□□□□□□□□help□□□□□□□□□□Extendedattributesarename:valuepairsa

5、ssociated□□□□□□□□□□withinodesbythekernelorbyusers(seetheattr(5)□□□□□□□□□□manualpage,orvisitfor□□□□□□□□□□details).-----------------------------------------------------------------□□□□□□□□□□Ifunsure,sayN.1.2头文件.h和.c文件规说明格式：制表符宽度相当于8个空格1.2.1文件首部注释文件首部的注释用于说

6、明文件信息，可选项目包括：文件所属模块主要函数实现作者信息信息软件说明以上容为可选信息，一个文件中不一定包含全部信息，由开发者根据重要性来确定。注释格式必须是块注释形式，即：以/*行开头，以*/行结束，中间每一行前面均加一个*，每行的*号在竖直方向是对齐排列的，容部分距离行首的距离为4个字符，每段容间空一行；作者信息部分若有多个作者，则每个作者单列一行，并与其他作者信息对齐；信息按时间段可分行说明，保持部对齐。示例如下图1.2,其中方框'□'代表一个空格:图1.2/*□*□□NSASecurity-EnhancedLinux(SELinu

7、x)securitymodule*□*□□ThisfilecontainstheSELinuxhookfunctionimplementations.*□*□□Authors:StephenSmalley,*ChrisVance,*□*□□Copyright(C)2001,2002NetworksAssociatesTechnology,Inc.□*□□Copyright(C)2004-2005TrustedComputerSolutions,Inc.□*

8、ustedcs.>*□*□□Thisprogramisfreesoftware;youcanredistributeitand/or□*□□modifyitunderthetermsofthe