C++、C、或者java,这些语言写代码时应该要怎么规范格式,

C++、C、或者java,这些语言写代码时应该要怎么规范格式,,第1张

C/C++源代码书写规范1 在h/cpp的开头应有一段格式统一的说明,内容包括:a 文件名 (FileName);b 创建人 (Creator);c 文件创建时间 (Date);d 简短说明文件功能、用途 (Comment)。例:////////////////////////////////////////////// FileName: GetVersionh// Creator: Liu Haifeng// Date: 2002-10-28// Comment: Get file version information////////////////////////////////////////////2对于主要功能函数应有注释说明。内容包括:功能、入口/出口参数,必要时还可有备注或补充说明,对于函数中的主要功能代码,也应有注释说明。注释以英文为主。例://////////////////////////////////////////////Remarks:// Check file whether exist////Parameters:// LPCTSTR lpszPathName : Input full path name////Return values:// int : Non-zero means success// Zero means failure////////////////////////////////////////////3 每列代码的长度推荐为80列,最长不得超过120列;折行以对齐为准。例:HANDLE KSOpenFile(const char cszFileName[],int nMode);或者:BOOL KSReadFile(HANDLE hFile,void pvBuffer,int nReadSize,int pnReadSize);4 循环、分支代码,判断条件与执行代码不得在同一行上。例:正确:if (n == -2)n = 1;elsen = 2;不得写做:if (n == -2) n = 1;else n = 2;5 指针的定义, 号既可以紧接类型,也可以在变量名之前。例:可写做:int pnsize;也可写做:int pnsize;但不得写做:int pnsize;6 在类的成员函数内调用非成员函数时,在非成员函数名前必须加上"::"。例:::Sleep(2000);7 函数入口参数有缺省值时,应注释说明。例:BOOL KSSaveToFile(const char cszFileName[],BOOL bCanReplace / = TRUE /);或者:BOOL KSSaveToFile(const char cszFileName[],BOOL bCanReplace // = TRUE);8 else if 必须写在一行。9 与‘{’、‘}’有关的各项规定:91‘{’、‘}’应独占一行。在该行内可有注释。例:正确:for (i = 0; i < cbLine; i++){ // printf("Line %d:", i);printf("%s\n", pFileLines);}不得写做:for (i = 0; i < cb; i++){ printf("Line %d:", i);printf("%s\n", pFileLines);}92‘{’必须另起一行,‘{’之后的代码必须缩进一个Tab。‘{’与‘}’必须在同一列上。例:正确:if (i > 0){m = 1;n++;}不得写做:if (i > 0) {m = 1;n++;}例外:if (i == 0){ ASSERT(FALSE); return; }93 在循环、分支之后若只有一行代码,虽然可省略‘{’、‘}’,但不推荐这么做。若省略后可能引起歧义,则必须加上‘{’、‘}’。例:正确:if (n == -2)n = 1;elsen = 2;或者:if (n == -2){ n = 1; }else if (n != nTemp){ n = 2; }else{ n = 3; }不得写做:if (n == -2)n = 1;else if (n != nTemp)n = 2;elsen = 3;不推荐:if (i < 1){ n = 1; }else{if (i == 1){ n = 2; }else{if (i > 1){ n = 3; }}}10 与空格有关的各项规定。101 在所有两目、三目运算符的两边都必须有空格。在单目运算符两端不必空格。但在‘->’、‘::’、‘’、‘[’、‘]’等运算符前后,及‘&’(取地址)、‘’(取值)等运算符之后不得有空格。例:正确:int n = 0, nTemp;for (int i = nMinLine; i <= nMaxLine; i++)不得写做:int n=0, nTemp;for ( int i=nMinLine; i<=nMaxLine; i++ )102 for、while、if 等关键词之后应有1个空格,再接‘(’,之后无空格;在结尾的‘)’前不得有空格。例:正确:if (-2 == n)不得写做:if(-2 == n)或if ( -2 == n )等等。103 调用函数、宏时,‘(’、‘)’前后不得有空格。例:正确:printf("%d\n", nIndex);不得写做:printf ("%d\n", nIndex);printf( "%d\n", nIndex );等等。104 类型强制转换时,‘(’‘)’前后不得有空格例:可写做:(KSFile)pFile;也可写做:(KSFile )pFile不得写做:( KSFile )pFile( KSFile ) pFile11 与缩进有关的各项规定111 缩进以 Tab 为单位。1 个 Tab 为 4 个空格112 下列情况,代码缩进一个 Tab:1 函数体相对函数名及'{'、'}'。例:int Power(int x){return (x x);}2 if、else、for、while、do 等之后的代码。3 一行之内写不下,折行之后的代码,应在合理的位置进行折行。若有 + - / 等运算符,则运算符应在上一行末尾,而不应在下一行的行首。113 下列情况,不必缩进:switch 之后的 case、default。例:switch (nID){case ID_PLAY:break;case ID_STOP:break;default:break;12对于涉及到系统的功能调用,要求使用系统提供的宏,不得直接使用具体的数值。例: char szSystemPath[MAX_PATH] = {0}; 正确char szSystemPath[260] = {0}; 错误13关于函数编写的规定131 除了非常简单的函数或者没有必要,函数需要有返回值,并且推荐返回值的类型为int,成功时为 true,失败时为false。不推荐直接使用1和0来表示。132 在函数内部变量定义全部放在函数的开始处,不能在代码中间出现 变量定义。变量定义需要初始化值,一般是0、false、NULL等。133 程序员自行编写的函数不推荐使用DWORD等指明字节长度的变量 类型,推荐使用unsigned long等变量类型。对于ULONG等vc系统定义的变量类型,推荐使用unsigned long 来代替。如果调用系统API,在MSDN中已经指明了是DWORD等类型,则可以使用。134 推荐使用int nResult作为函数自身的返回值变量,int nRetCode、BOOL bRetCode作为调用其他函数的返回值变量。135 推荐使用goto语句来统一函数出口,goto语句一般只能跳转到一个函数出口,最多只能有两个,出口标识必须命名为Exit0和Exit1。在出口处必须显式检查曾经申请过的系统资源(如内存),并且进行释放。136 如果编写DLL,除非特殊情况,导出函数的调用类型必须是__stdcall,便于多模块协同工作。附录:1.函数编写示范///////////////////////////////////////////////////////////////////////// Remarks:// Get file version information//// Parameters:// [in] const char cszPathName : Input file path name// [out] PVERSION_INFO pVersionInfo : File version information//// Return values:// int : Non-zero means success, zero means failure///////////////////////////////////////////////////////////////////////int GetFileVersion(const char cszPathName, PVERSION_INFO pVersionInfo){int nResult = false;int nRetCode = false;char szSystemPath[MAX_PATH] = {0};nRetCode = IsFileExist(cszPathname);if (!nRetCode)goto Exit0;//Others code herenResult = true;Exit0:return nResult;}以前你的习惯可能是我定义一个函数,通过传递参数去实现这个函数的功能。面向对象编程要体现三个特点“封装、继承、多态”;比如你写一个飞这个函数,你需要在这里传递参数飞机。换个角度,你定义一个类是飞机,那这个飞机在封装的过程就有飞。降落等这功能(函数)。你想要用飞这个功能(函数)的时候,你只需调用飞机这个类“飞”这个成员函数。

对于每个程序员来说,养成良好的代码编写方法是非常关键的。在编写代码的过程中,每个人的方法是不同的,那么应该如何规范自己代码编写的方法呢?规范编写代码有哪些要求呢?下面电脑培训带大家认识代码编写的方法。

一、保证代码压缩后不会出错

对于大的JavaScript项目,一般来说,包含在项目中的所有JavaScript文件在产品公开时都会被压缩。为了正确压缩代码,通常需要考虑压缩工具的必要条件,如句子用分号正常结束,中括号结束等。因此,IT培训发现当编写代码没有按照标准进行时,在发生压缩错误后再次寻找错误是浪费时间的。

二、保证代码能够通过自动格式化功能

一般情况下需要使用完善的开发工具进行自动化格式功能,这个功能能够进行换行、缩进和空格等方法的代码编排,并且还可以设置自己喜欢的格式。别人在阅读你的代码时需要使用IDE进行格式转换,以满足个人的阅读风格。昌平北大青鸟认为阅读代码能够更加深入的了解代码调用和细节的实现,这是简单的文档不能实现的。

三、使用标准的文档注释

这是编写代码中最基本的要求,能够很好的了解代码的提示,并且还可以利用配套的文档工具生产其他格式让别人阅读。北大青鸟认为编写完整的注释还可以使团队成员更容易阅读您的代码。通过您的参数描述,团队成员很容易了解您想要传递参与实现细节和编写的方法。

国家标准的代号由大写汉语拼音字母构成。

强制性国家标准的代号为“GB”,

推荐性国家标准的代号为“GB/T”。

国家标准的编号由国家标准的代号、国家标准发布的顺序号和国家标准发布的年号(即发布年份的后两位数字)构成。

示例:GB×××××–××GB/T×××××–×× 

国家标准的代号由《国家标准管理办法》第四条进行规定。

发布机构:国家技术监督局第10号令

发布日期:19900824

生效日期:19900824

《国家标准管理办法》是为更好地实施《中华人民共和国标准化法》而颁布的管理办法,对国家实施技术监督标准有重要作用。

行业标准

名称 代号 名称 代号 名称 代号

中医药行业标准 ZY 邮政行业标准 YZ 医药行业标准 YY

有色冶金行业标准 YS 通信行业标准 YD 烟草行业标准 YC

黑色冶金行业标准 YB 稀土行业标准 XB 卫生行业标准 WS

外贸行业标准 WM 文化行业标准 WH 物资行业标准 WB

土地行业标准 TD 铁道行业标准 TB 石油行业标准 SY

商品检验行业标准 SN 水利行业标准 SL 电子行业标准 SJ

石油化工行业标准 SH 水产行业标准 SC 商业行业标准 SB

气象行业标准 QX 航天行业标准 QJ 汽车行业标准 QC

轻工业行业标准 QB 农业行业标准 NY 民政行业标准 MZ

煤炭行业标准 MT 民用航空行业标准 MH 林业行业标准 LY

劳动行业标准 LD 旅游行业标准 LB 教育行业标准 JY

金融行业标准 JR 交通行业标准 JT 建筑行业工程建设规程 JGJ

建筑行业标准 JG 建材行业标准 JC 机械行业标准 JB

海关行业标准 HS 环保行业标准 HJ 海洋行业标准 HY

化工行业工程建设规程 HGJ 化工行业标准 HG 航空行业标准 HB

广播**电视行业标准 GY 供销合作行业标准 GH 公安行业标准 GA

纺织行业标准 FZ 核工业行业标准 EJ 地质行业标准 DZ

电力行业标准 DL 地震行业标准 DB 档案行业标准 DA

新闻出版行业标准 CY 城建行业工程建设规程 CJJ 城建行业标准 CJ

工程建设推荐性标准 CECS 测绘行业标准 CH 船舶行业标准 CB

包装行业标准 BB

BER:基本编码规则 (Basic Encoding Rules)

基本编码规则(BER),定义在 ITU-T X209 中,是指在 ASN1 标准(定义在 ITU-T X208 中)中描述的数据编码/解码规则。基本的编码规则可能被用于为类型值取得传输语法的规范,使用 ASN1 指定在推荐 X208 中定义的。一单个 ASN1 对象可能有几个等价的 BER 编码。BER 是当前 CryptoAPI 使用的两种编码方法之一。

你想问编码规范。还是设计规范 还是界面规范 还是 *** 作规范

编码规范:

代码书写规范(如程序结构。。。)

代码注释规范(文件头注释、类注释、方法注释、注释的类型。。。)

代码命名规范(属性、方法、字段、事件、。。。如何是规范命名)

以上就是关于C++、C、或者java,这些语言写代码时应该要怎么规范格式,全部的内容,包括:C++、C、或者java,这些语言写代码时应该要怎么规范格式,、程序员如何规范代码的编写方法、国家标准编码规则是什么如行业标准代码等相关内容解答,如果想了解更多相关内容,可以关注我们,你们的支持是我们更新的动力!

欢迎分享,转载请注明来源:内存溢出

原文地址: https://outofmemory.cn/zz/9440607.html

(0)
打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
上一篇 2023-04-28
下一篇 2023-04-28

发表评论

登录后才能评论

评论列表(0条)

保存