美文网首页
【学习】“注释”规则6:全局变量要有较详细的注释

【学习】“注释”规则6:全局变量要有较详细的注释

作者: 老k的小茅屋 | 来源:发表于2025-08-28 15:36 被阅读0次

全局变量要有较详细的注释,包括对其功能、取值范围以及存取时注意事项等的说明。

示例:

/* The ErrorCode when SCCP translate */

/* Global Title failure, as follows */ /* 变量作用、含义*/

/* 0 -SUCCESS 1 -GT Table error */

/* 2 -GT error Others -no use */ /* 变量取值范围*/

/* only function SCCPTranslate() in */

/* this modual can modify it, and other */

/* module can visit it through call */

/* the function GetGTTransErrorCode() */ /* 使用方法*/

BYTE g_GTTranErrorCode;


参考:gitcode社区-开源文档-菊厂C编程规范

相关文章

  • lua基础概要

    关键字 变量 定义全局变量 定义局部变量 代码注释 行注释 -- 使用 -- 可以注释到行尾 块注释 --[[]]...

  • 奇葩注释整理

    注释 1 注释 2 注释3 注释4 注释5 注释6 注释7 注释8 注释9 注释10 注释11 注释12 注释13...

  • Javascript语法和类型

    前端7班_leec 注释 注释的规则跟C++和其他语言类似,单行注释用//,多行注释通过/*注释内容*/: 声明 ...

  • Java基础复习

    注释 Java语言的注释有三种 单行注释 多行注释 文档注释 CSDN中这篇文章详细描述了java文档注释的各种用...

  • Groovy语法

    注释 单行注释// 多行注释/**/ // GroovyDoc注释/** */ 变量名 普通变量名和Java规则一...

  • 使用eslint --ext .js,.vue src 修复 .

    带详细注释

  • 12_注释符号

    关键词:注释规则 1. 注释规则 编译器在编译过程中使用空格替换整个注释 字符串字面量的//和/*...*/不代表...

  • 图的深度搜索和广度搜索代码

    详细解释见代码注释。

  • python_使用matplotlib画饼状图(pie)

    代码与详细注释 结果

  • PHP基础教程002:注释

    每一种编程语言都有属于自己的注释规则,PHP也是一样的。 单行注释不会注释掉PHP的结束符。、 多行注释会注释掉结束符

网友评论

      本文标题:【学习】“注释”规则6:全局变量要有较详细的注释

      本文链接:https://www.haomeiwen.com/subject/kqrfajtx.html