Loading [MathJax]/jax/output/CommonHTML/config.js
首页
学习
活动
专区
圈层
工具
发布
首页
学习
活动
专区
圈层
工具
MCP广场
社区首页 >专栏 >我的C语言编码习惯(注释篇)

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

作者头像
Taishan3721
发布于 2022-12-05 08:00:02
发布于 2022-12-05 08:00:02
1K00
代码可运行
举报
文章被收录于专栏:这里只有VxWorks这里只有VxWorks
运行总次数:0
代码可运行

尽量少写注释

需有必要性和确定性

单行注释如下,注意空格

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
/* this is a single line comment */

多行注释如下,注意对齐

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
    /*
     * this is a multiline comment
     * this is the second line
     */

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

注释之后没有空行

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

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

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

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

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

不使用嵌套注释

不使用双斜线注释

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

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
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 删除。

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

评论
登录后参与评论
暂无评论
推荐阅读
编辑精选文章
换一批
【C语言】C 语言编码风格(基于 ISO/IEC 9899:2024 和 Linux 内核编码风格 v6.13.0-rc4)
C 语言的编码风格对于编写清晰、可维护、易于调试的代码至关重要。本文将结合 ISO/IEC 9899:2024 (N3220) 标准(即 C23 标准)和 Linux 内核编码风格 v6.13.0-rc4,全面讲解 C 语言编码规范。这两个文献代表了行业中的两个重要编码风格,本文将结合它们的规则和最佳实践进行对比分析,并提供代码示例。
LuckiBit
2024/12/27
5400
【C语言】C 语言编码风格(基于 ISO/IEC 9899:2024 和 Linux 内核编码风格 v6.13.0-rc4)
我的C语言编码习惯(限制篇)
为防止头文件的重复引用,定义宏__INCfileNameh 为兼容C++,添加extern "C" /* semLib.h */ #ifndef __INCsemLibh #define __INCsemLibh #include <vxWorks.h> #ifdef __cplusplus extern "C" { #endif #define SEM_Q_MASK 0x03 extern STATUS semShow(SEM_ID semId, int level); #ifdef
Taishan3721
2022/12/05
8130
我的C语言编码习惯(限制篇)
初识C语言:注释、关键字、常量、变量
​ 我亲亲女朋友的姓名是:小诗诗。性别:女。年龄:18岁。身高:1米82。体重:110斤。
曾高飞
2025/06/03
1530
C语言规范_V1.1
代码编写规则应该在建立在一个工程项目之前。该规则应该贯穿整个项目的始终以保证代码的一致性。采用标准的代码编写惯例,可大大简化项目的维护负担。在C语言中可以有多种代码的编写方法(当然其它编程序语言亦如此),你可以尽可能采用一种好的风格,以达到以下目的: 可移植 (Portability) 连贯 (Consistency) 整洁(Neatness) 易于维护(Easy Maintenance) 易于理解(Easy Understanding) 简洁(Simplicity) 不管你采用那种风格,我所强调的就是:这种风格一定要贯穿你项目的始终。在以后的内容中我还要提到:即使在一个团队合作的大型项目中,这种风格也要贯穿始终。采用通用的代码编写风格可以减轻代码维护的工作量并降低维护费用;这种通用的代码风格还可以避免重写代码。
开源519
2020/07/23
8320
值得一看:老外的嵌入式编程规范
作为维护人员,如果收到的补丁明显与周围代码的编码风格不同,这是令人沮丧的。这是不尊重人的,就像某人穿着泥泞的鞋子走进一间一尘不染的房子。
AI 电堂
2021/07/02
1.4K0
良好的CSS编码习惯
一个 css 文件的核心内容是由许许多多的 css 规则组成的,而每个规则又包含了两部分:选择器和声明;声明块里可能又包含多个声明,每个声明又是由属性和值组成的。这个大概就是 css 的代码结构。
用户4456933
2021/06/01
6890
良好的CSS编码习惯
【C语言指南】注释
条件编译指令#if后面跟整型常量表达式。如果表达式为非零,则表达式为真,编译器条件执行代码块;反之,编译器忽略代码块。
倔强的石头_
2024/12/06
3250
哦!这该死的 C 语言!
C 语言是一门抽象的、面向过程的语言,C 语言广泛应用于底层开发,C 语言在计算机体系中占据着不可替代的作用,可以说 C 语言是编程的基础,也就是说,不管你学习任何语言,都应该把 C 语言放在首先要学的位置上。下面这张图更好的说明 C 语言的重要性
C语言与CPP编程
2020/12/02
5470
哦!这该死的 C 语言!
江哥带你玩转C语言 | 03-C语言关键字和标识符
什么是注释? 注释是在所有计算机语言中都非常重要的一个概念,从字面上看,就是注解、解释的意思 注释可以用来解释某一段程序或者某一行代码是什么意思,方便程序员之间的交流沟通 注释可以是任何文字,也就是说
极客江南
2021/07/11
6770
[C语言]概述
本文章将围绕C展开来写一篇基础(小白)的博客。本人想从零基础开始慢慢的写,所以就先从概述开始了,慢慢的由低到高吧,就像是我们一开始都是从hello word开始入门一样。当然这篇博客大家可能会觉得水🌊
謓泽
2022/12/12
6430
[C语言]概述
制定自己团队的前端开发规范
后续的文章我也补充齐全了,一共有两篇,都是实战篇,一篇是制定自己团队的前端开发规范之 eslint,另外一篇是手摸手带你实践标准的前端开发规范,希望大家可以去看一下,然后把这套规范实践起来,让自己的开发存在更少的bug。
用户1462769
2019/08/09
9940
Go 语言基础:包、函数、语句和注释解析
第 1 行: 在 Go 中,每个程序都是一个包的一部分。我们使用 package 关键字来定义它。在这个例子中,程序属于 main 包。
小万哥
2023/12/24
2150
Go 语言基础:包、函数、语句和注释解析
我的C语言编码习惯(Name与Type)
文件名后缀使用小写 文件名/函数名/变量名采用小驼峰式命名法(lower camel case) 宏定义采用全大写加下划线方式 常量使用宏定义,常见的0/1可例外 变量/类型不同名 public头文件放入public目录,引用时使用 #include <> private头文件与源文件放入同一目录,引用时使用 #include "" 在头文件声明public函数 不声明private函数,使用static类型实现于调用者之前 static变量/函数不放入头文件 不使用全局变量,改为set
Taishan3721
2022/12/05
4990
我的C语言编码习惯(Name与Type)
C语言进阶——程序环境和预处理
  在C/C++中,所有的代码在输出结果前都需要经过这五个阶段:预编译—>编译—>汇编—>链接—>执行代码。其中前四个阶段是在翻译环境下进行,因为在翻译环境中有编译器和链接器这两个重要工具,二者配合能将文本形式的代码转化为对应的二进制代码和可执行文件;而最后一个阶段是在执行环境中进行的,代码在这个阶段已经打包好了,只需要执行器运行此代码,结果就能很好的输出。可以看出,整个代码运行逻辑是极其严谨和巧妙的。除程序环境外,C/C++在预处理阶段还有各式各样的预处理指令等着我们去发掘,一起来看看吧!
北 海
2023/07/01
3390
C语言进阶——程序环境和预处理
我的C语言编码习惯(空格篇)
国有国法,家有家规。多数公司有自己的编码规范,每个developer有自己的编码风格。无关对错,只是记录一下我自己的习惯:
Taishan3721
2022/12/05
1.2K0
C++打怪 之 编程风格指南 V1.0
C++用法很多,包容性也比较强。一个C++的工程可能包含了各种各样没见过的用法。本篇内容主要是参照谷歌C++标准规范,结合自身实际工作 及经验,整理一份适合平时C++开发的规则,规范自身C++编程规范。详细内容可参考《Google C++风格指南》。
开源519
2021/01/27
1.4K0
【愚公系列】2021年12月 Java教学课程 04-Java语言三种注释
注释就是对代码的解释和说明,其目的是让人们能够更加轻松地了解代码。注释是编写程序时,写程序的人给一个语句、程序段、函数等的解释或提示,能提高程序代码的可读性。
愚公搬代码
2021/12/28
1820
规范JavaScript注释
//(双斜线)与代码之间保留一个空格,并且//(双斜线)与注释文字之间保留一个空格。
Dreamy.TZK
2020/06/28
13.6K0
C语言基础01--初见C语言
C语言基础--初见C语言 一 常见函数: 默认情况下,main函数是C语言的起点 printf()函数是格式化输出函数 (来自stdio.h) 单行注释:/ 单行内容 / 多行注释:/* 多行内容 */ 二 使用VS2015创建项目: 1. 新建项目 2. 依次选择vc++ ,win32 ,win32控制台程序 3.随便写个项目名称 4. 应用程序向导里选择空项目,其他默认 5. 从源文件添加新建项,创建.c文件 三 第一个程序: #include<stdio.h> int main() {
Ms08067安全实验室
2020/05/24
10.2K0
Python 进阶指南(编程轻松进阶):十一、注释、文档字符串和类型提示
注释、文档字符串和类型提示帮助你保持代码的可读性。注释是简单明了的简短解释,你直接写在源代码中,计算机会忽略它们。注释为那些没有编写代码的人提供了有用的注释、警告和提醒,或者有时甚至为将来代码的程序员提供了帮助。几乎每个程序员都问过自己,“谁写了这些不可读的东西?”却发现答案是,“我做的。”
ApacheCN_飞龙
2023/04/09
1.1K0
Python 进阶指南(编程轻松进阶):十一、注释、文档字符串和类型提示
相关推荐
【C语言】C 语言编码风格(基于 ISO/IEC 9899:2024 和 Linux 内核编码风格 v6.13.0-rc4)
更多 >
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档
本文部分代码块支持一键运行,欢迎体验
本文部分代码块支持一键运行,欢迎体验