首页 > 其他分享 >编码规范

编码规范

时间:2024-09-06 22:35:57浏览次数:13  
标签:编码 函数 规范 注释 使用 命名 全局变量 变量

编码规范

华为的编码规范主要包括以下几个方面:

命名约定:变量、函数等命名应清晰、明了,有明确含义,避免使用单个字符或容易混淆的缩写。常量命名应全部大写,单词间用下划线分隔。文件命名应遵循特定规则,如C文件以.cpp结尾,头文件以.h结尾。

排版格式:使用空格进行缩进,每次缩进4个空格。行宽建议不超过120个字符。大括号应各独占一行,并位于同一列。在操作符两侧、逗号后、分号后等位置应添加空格。

注释风格:文件头注释必须包含版权许可、版本号、生成日期、作者等信息。函数头注释应列出函数的目的、功能、输入参数、输出参数、返回值等。

作用域管理:优先使用命名空间来管理全局函数、全局常量和全局变量。使用匿名命名空间或static关键字来封装不需要导出的变量、常量或函数。

头文件使用:每个.cpp文件应有一个对应的.h文件,用于声明需要对外公开的类与接口。

变量:一个变量只能有一个功能,避免使用全局变量,明确全局变量的初始化顺序。

表达式:确保表达式的值在任何允许的标准运算次序下都是相同的。避免在if语句或函数参数中使用赋值语句。

注释:注释内容要清楚明确、不能有歧义。文件头部应进行详细注释,包括版权说明、版本号等。

阿里巴巴的Java编码规范则涵盖了以下方面:

编程规约:手册分为编程规约、异常日志、单元测试、安全规约、MySQL数据库、工程结构、设计规约等维度。

方法参数类型:必须一致,避免出现自动装箱拆箱操作,以防产生难以排查的异常。

SimpleDateFormat的使用:指出SimpleDateFormat是线程不安全的,提示开发者在使用时需要注意。

对于我而言,我应该要遵守:

  1. 命名约定

    变量和函数:使用有意义的英文单词,避免使用缩写,使得代码自解释。例如,使用userCount而不是uc。
    常量:全部大写,并用下划线分隔单词,如MAX_USERS。

  2. 排版格式

    缩进:使用4个空格进行缩进,不使用Tab。
    行宽:每行代码不超过100个字符。
    大括号:遵循K&R风格,即左大括号后换行,右大括号前换行。

  3. 注释风格

    文件头注释:包括版权信息、文件描述、版本信息等。
    函数注释:描述函数的功能、参数、返回值和可能的异常。

  4. 作用域管理

    命名空间:使用命名空间来避免全局变量和函数的冲突。
    静态变量:尽量使用静态变量替代全局变量。

  5. 变量使用

    单一职责:一个变量只用于一个目的,避免多功能变量。

标签:编码,函数,规范,注释,使用,命名,全局变量,变量
From: https://www.cnblogs.com/sakura-12/p/18401177

相关文章

  • idea安装git commit comment plugin增强git提交注释规范
    一、安装插件打开idea的设置界面并找到插件二、重启idea并打开gitcommittemplate三、打开提交弹窗,可以选择gitcomment的类型说明安装成功......
  • CABAC熵编码详解
    信息熵是指信号源(信源)的信息量。设有一个离散信源,{$X_i$},i=1,2..,N,它产生消息的概率是已知的,记为,P({$X_i$})),$\sum_{i=1}^{N}P(X_i)=1$,则信息量定义为:$I(X_i)=\log_{2}{\frac{1}{P(X_i)}}=-\log_{2}{P(X_i)}bit$信息量仅反映了一个符号的信息量的大小,而信源都是由若干个符......
  • 软设每日打卡——霍夫曼编码将频繁出现的字符釆用短编码,出现频率较低的字符采用长编码
    【题目】霍夫曼编码将频繁出现的字符釆用短编码,出现频率较低的字符采用长编码。具体        的操作过程为:i)以每个字符的出现频率作为关键字构建最小优先级队列;ii)取出关键        字最小的两个结点生成子树,根节点的关键字为孩子节点关键字之和,并将根节点......
  • 《C++编程规范》五、类的设计与继承
    目录第32条弄清所要编写的是哪种类第32条弄清所要编写的是哪种类了解自我:有很多种不同的类。弄清楚要编写的是哪一种。不同种类的类适用于不同用途,因此遵循着不同的规则。值类(如std::pair,std::vector)模仿的是内置类型。一个值类应该:有一个公用析构函数、复制构造函......
  • 【自由能系列(中级),代码模拟】预测编码的核心:三个关键方程式的详解
    预测编码的核心:三个关键方程式的详解——探索预测编码背后的数学原理与应用核心结论:预测编码是一种基于贝叶斯定理的理论框架,它通过三个关键方程式描述了大脑如何处理和解释来自环境的信号。这些方程式分别建立了贝叶斯定理的简化形式、生成模型以及观察者模型,共同揭示了......
  • 【编码技巧】批量校验或处理关联引用数据的优化总结
    问题描述:      之前有信创项目反馈了一个批量导入的性能问题,400条数据需要3分钟,5000条需要20分钟以上,系统初始需要导入的各类数据有上百万。原因分析:      联系项目导入20~30条数据,并启用程序跟踪收集性能数据发现,有大量对字典表的SQL查询。      与功能......
  • base64是什么,在 C# 中对 Base64 字符串进行编码和解码
    原文链接:https://blog.csdn.net/ty_oldman/article/details/116306785         https://blog.csdn.net/qq_55752792/article/details/139681358base64是什么Base64编码,是由64个字符组成编码集:26个大写字母AZ,26个小写字母az,10个数字0~9,符号“+”与符号“/”。Bas......
  • 一文教会你如何用好通义灵码,让这款 AI 编码工具帮你做更多工作,更高效
    通义灵码,是阿里云与通义实验室联合打造的智能编码辅助工具,提供行级/函数级实时续写、自然语言生成代码、单元测试生成、代码优化、注释生成、代码解释、研发智能问答、异常报错排查等能力,提供代码智能生成、研发智能问答能力。国际市场研究机构Gartner发布业界首个AI代码助手魔......
  • 一文教会你如何用好通义灵码,让这款 AI 编码工具帮你做更多工作,更高效
    通义灵码,是阿里云与通义实验室联合打造的智能编码辅助工具,提供行级/函数级实时续写、自然语言生成代码、单元测试生成、代码优化、注释生成、代码解释、研发智能问答、异常报错排查等能力,提供代码智能生成、研发智能问答能力。国际市场研究机构Gartner发布业界首个AI代码助手魔......
  • 一文教会你如何用好通义灵码,让这款 AI 编码工具帮你做更多工作,更高效
    通义灵码,是阿里云与通义实验室联合打造的智能编码辅助工具,提供行级/函数级实时续写、自然语言生成代码、单元测试生成、代码优化、注释生成、代码解释、研发智能问答、异常报错排查等能力,提供代码智能生成、研发智能问答能力。国际市场研究机构Gartner发布业界首个AI代码助手......