前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >我的C语言编码习惯(注释篇)

我的C语言编码习惯(注释篇)

作者头像
Taishan3721
发布2022-12-05 16:00:02
9090
发布2022-12-05 16:00:02
举报
文章被收录于专栏:这里只有VxWorks

尽量少写注释

需有必要性和确定性

单行注释如下,注意空格

代码语言:javascript
复制
/* this is a single line comment */

多行注释如下,注意对齐

代码语言:javascript
复制
    /*
     * this is a multiline comment
     * this is the second line
     */

注释之前若为同级代码,则有一个空行

注释之后没有空行

行尾如需注释,尽量使用单行注释

相同成员的行尾注释要对齐

行尾如需多行注释,其第一行不用为空

函数头注释包含功能描述、入参、返回值等

如果宏当作函数使用,使用与函数类似的注释

不使用嵌套注释

不使用双斜线注释

可使用宏开关代替注释,尤其是多行注释

代码语言:javascript
复制
void test(int data)
{
#if 0
    if(data < 0)
        {
        printf("data=%d\n", data);
        }
#endif

    printf("data=%u\n", data);
    return;
    }
本文参与 腾讯云自媒体同步曝光计划,分享自微信公众号。
原始发表:2022-11-14,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 这里只有VxWorks 微信公众号,前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档