首页 > 其他分享 >大二要做到的代码规范

大二要做到的代码规范

时间:2024-09-04 16:37:25浏览次数:10  
标签:头文件 标识符 代码 注释 命名 cpp 大二 做到

节选自阿里云社区https://developer.aliyun.com/article/193763
正文如下:
代码编写规范
一、排版
1.包含头文件
1.1 先系统头文件,后用户头文件
1.2 只引用需要的头文件
2.h和cpp文件
2.1 头文件命名为.h,内联文件命名为.inl;C++文件命名为*.cpp
2.2 文件名用大小写混合,或者小写混合。例如DiyMainview.cpp,infoview.cpp。不要用无意义的名称:例如XImage.cpp;SView.cpp;xlog.cpp;
二、注释
1.文件头注释
1.1 作者,文件名称,文件说明,生成日期(可选)
2.函数注释
2.1 关键函数必须写上注释,说明函数的用途。

	2.2 特别函数参数,需要说明参数的目的,由谁负责释放等等。

	2.3 除了特别情况,注释写在代码之前,不要放到代码行之后。

	2.4 对每个#else或#endif给出行末注释。

	2.5 关键代码注释,包括但不限于:赋值,函数调用,表达式,分支等等。

	2.6 善未实现完整的代码,或者需要进一步优化的代码,应加上 // TODO ...

	2.7 调试的代码,加上注释 // only for DEBUG

	2.8 需要引起关注的代码,加上注释 // NOTE ...

	2.9 对于较大的代码块结尾,如for,while,do等,可加上 // end for|while|do

三、命名方面
1.1.原则

1.1 同一性:在编写一个子模块或派生类的时候,要遵循其基类或整体模块的命名风格,保持命名风格在整个模块中的同一性。

1.2 标识符组成:标识符采用英文单词或其组合,应当直观且可以拼读,可望文知意,用词应当准确,避免用拼音命名。

1.3 最小化长度 && 最大化信息量原则:在保持一个标识符意思明确的同时,应当尽量缩短其长度。

1.4 避免过于相似:不要出现仅靠大小写区分的相似的标识符,例如"i"与"I","function"与"Function"等等。

1.5 避免在不同级别的作用域中重名:程序中不要出现名字完全相同的局部变量和全局变量,尽管两者的作用域不同而不会发生语法错误,但容易使人误解。

1.6 正确命名具有互斥意义的标识符:用正确的反义词组命名具有互斥意义的标识符,如:"nMinValue" 和 "nMaxValue","GetName()" 和"SetName()" ….

1.7 避免名字中出现数字编号:尽量避免名字中出现数字编号,如Value1,Value2等,除非逻辑上的确需要编号。这是为了防止程序员偷懒,不肯为命名动脑筋而导致产生无意义的名字(因为用数字编号最省事)。

标签:头文件,标识符,代码,注释,命名,cpp,大二,做到
From: https://www.cnblogs.com/Lin-4126/p/18396817

相关文章

  • GBDT模型 0基础小白也能懂(附代码)
    GBDT模型0基础小白也能懂(附代码)原文链接啥是GBDTGBDT(GradientBoostingDecisionTree),全名叫梯度提升决策树,是一种迭代的决策树算法,又叫MART(MultipleAdditiveRegressionTree),它通过构造一组弱的学习器(树),并把多颗决策树的结果累加起来作为最终的预测输出。该算法将决策树与......
  • 体验通义灵码 @workspace:轻松分析项目结构,结合代码仓库理解工程、查询问答等
    国际市场研究机构Gartner发布业界首个AI代码助手魔力象限,阿里云进入挑战者象限。通义灵码在产品功能和市场应用等方面表现位列国际前列,在国内同类产品中排名第一。在关键能力评分中,通义灵码在代码生成、代码解释、代码调试等多项能力领先,其中代码解释能力位列全球第二。这也是......
  • 体验通义灵码 @workspace:轻松分析项目结构,结合代码仓库理解工程、查询问答等
    国际市场研究机构Gartner发布业界首个AI代码助手魔力象限,阿里云进入挑战者象限。通义灵码在产品功能和市场应用等方面表现位列国际前列,在国内同类产品中排名第一。在关键能力评分中,通义灵码在代码生成、代码解释、代码调试等多项能力领先,其中代码解释能力位列全球第二。这也是......
  • S-Clustr(影子集群) Simple SCC伪代码编译器,工业控制DSL结构语言,递归函数调用
    项目地址:https://github.com/MartinxMax/S-Clustr/releases200S-ClustrSimpleDSL语法内置函数示例RUN(启动设备)RUN:<ID>STOP(停止设备)STOP:<ID>TIME(MS延时)TIME:<Delay/Ms>函数示例DEF(定义函数名,空形参)DEFFunction:DEF(函数名,带形参)DEFFunction:var,......
  • 代码执行详解
    代码执行定义        应用程序在调用一些能够将字符串转换为代码的函数(如PHP中的eval)时,没有考虑用户是否控制这个字符串,将造成代码执行漏洞。代码执行的原理        应用程序本身过滤不严,用户可以通过请求将代码(代码字符串)注入到应用中执行。代码执行相......
  • 体验通义灵码 @workspace:轻松分析项目结构,结合代码仓库理解工程、查询问答等
    国际市场研究机构Gartner发布业界首个AI代码助手魔力象限,阿里云进入挑战者象限。通义灵码在产品功能和市场应用等方面表现位列国际前列,在国内同类产品中排名第一。在关键能力评分中,通义灵码在代码生成、代码解释、代码调试等多项能力领先,其中代码解释能力位列全球第二。这也......
  • C# .Net使用的代码混淆工具 ConfuserEx
    原文链接:https://www.cnblogs.com/lg-lg/articles/17803347.html开源.net混淆器ConfuserEx介绍下载地址:https://github.com/yck1509/ConfuserEx/releases第一步:第二步:第三步:当日志显示绿色Finish即是执行成功了......
  • API接口的请求方式及其示例代码​
    API的请求方式主要包括以下几种,这些方式分别对应了HTTP协议中的不同方法,用于实现不同的数据交互需求:GET请求:用途:用于从服务器获取数据。特点:将请求的参数包含在URL中,并以键值对的形式进行传输。由于参数暴露在URL中,因此它适用于获取公开的数据,如天气信息、新闻等。GET请求一般是幂......
  • 神奇的C语言输出12天圣诞节歌词代码
    12天圣诞节程序怎样运行?1988年,一个令人印象深刻且令人敬畏的C代码,代号为xmas.c,在国际混淆C代码竞赛中获胜。该程序甚至比其输出的“压缩”类型还要小,代表了文本压缩标准的全新方式。评委们认为,这个程序像是随意敲击键盘所得到的。但该程序神奇地打印出12天圣诞节的歌词,仅仅......
  • 达梦建包含匿名块的匿名代码块时莫名的报错
    有时候,我们只需要建执行执行一次的存储过程。那建匿名代码块是比较好的实现方式。但是在达梦在建包含匿名块的匿名代码块时会有莫名的报错。例如,以下匿名代码块,执行就会报错,但是在oracle执行是可以的。beginforfin(selecttable_namefromuser_tables)loopbegindbms_ou......