zoukankan      html  css  js  c++  java
  • 编码规范

    对变量的定义,尽量位于函数的开始位置
    命名规则

    • 匈牙利命名法
    • 骆驼命名法
    • 帕斯卡命名法

    函数内声明的变量或者函数的参数(使用栈内存)的大小不能超过1K,全局变量不能超过10K
    if、for、while、switch等与后面的括号间应加空格,使if等关键字更为突出、明显
    接口消息定义和内部数据结构定义都采用4字节对其方式
    一般情况下,源程序有效注释量必须在20%以上

    1. 先写一行代码,然后马上写注释
    2. 先写注释,再写代码
    3. 先把代码全写完了,再补注释

    第一种方式应用比较多,主要用与代码不是特别复杂的情况
    第二种方式主要用于代码结构非常复杂的情况

    数据结构声明(包括数组、结构、类、枚举等)必须加以注释。对结构中的每个域的注释放在此域的右方
    if, for, while, switch必须注释,写明其用途,取值范围
    防止局部变量与公共变量同名
    对变量,尤其是指针变量,强烈推荐在使用前将其初始化
    编写严谨的代码。将编译器的的告警级别设置高,使用检查工具(如Lint)
    较长的语句、表达式等要分成多行书写
    避免使用不易理解的数字
    不要使用难懂的技巧性很高的语句
    函数的规模尽量限制在200行以内
    一个函数最好仅完成一件功能
    为简单功能编写函数

  • 相关阅读:
    Django连接SQL Server,安装相关扩展包及相关配置
    安装pipenv
    报错及网络上的解决方案
    Nucleus-SE迁移:未实现的设施和兼容性
    RTOS诊断和错误检查
    Nucleus SE RTOS初始化和启动
    Nucleus 实时操作系统中断(下)
    Nucleus 实时操作系统中断(上)
    系统时间
    应用程序计时器
  • 原文地址:https://www.cnblogs.com/zhangxuechao/p/11709733.html
Copyright © 2011-2022 走看看