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

2025-08-28  本文已影响0人  老k的小茅屋

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

示例:

/* 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编程规范

上一篇 下一篇

猜你喜欢

热点阅读