嵌入式 C 注释风格

注释

1. 文件注释

/**
******************************************************************************
* @file
* @author
* @version V1.0.0
* @date 2017-5-7 10:46:21
* @brief This file provides template for all peripherals interrupt service routine.
******************************************************************************
* @attention
*
******************************************************************************
*/

2. 函数注释

/**
* @brief Returns the selected Button state.
* @param Button: Specifies the Button to be checked.
* This parameter can be one of following parameters:
* @arg BUTTON_KEY: Key Push Button
* @arg BUTTON_RIGHT: Joystick Right Push Button
* @arg BUTTON_LEFT: Joystick Left Push Button
* @arg BUTTON_UP: Joystick Up Push Button
* @arg BUTTON_DOWN: Joystick Down Push Button
* @arg BUTTON_SEL: Joystick Sel Push Button
* @retval The Button GPIO pin value.
*/

3. 语句注释

/* ... */
注释放在代码前

变量命名

1. 全局变量

全局变量命令符合以下规则:

  • 全局变量加 g 前缀 eg: uint_t g_UserCount;
  • 静态全局变量加 s 前缀 eg: uint8_t s_EenterTimes;
  • 局部变量全部小写，用_分隔单词 eg: uint8_t tmp_val;
时间： 2024-10-18 11:15:21

嵌入式 C 注释风格的相关文章

PHPDOC文档工具注释风格整理

自动生成PHP文档工具PHPdocument的Api文档之中标签注释风格集锦. 官网Api链接: https://docs.phpdoc.org/references/phpdoc/index.html 范例:从上面的看就是非常凌乱的注释风格,非常随性,有点low,现在规范一下,在  http://php.net/manual/zh/  并未找到注释风格的章节说明,那么就以开源工具phpdoc的注释风格为准好了. 由于phpdoc文档说明很多而且很多并没用到的,网站打开又比较慢,那么在这里就整理

使用vim正则表达式删除C/C++注释 及 两种注释风格替换

/*对于C风格的注释可以使用如下命令*/ :%s/\_s*\/\*\(\S\|\_s\)\{-}\*\///g //对于C++风格注释 %s/\/\/.*//g /*...*/ -> //... (仅限单行) :%s/\/\*\(\(\S\|\_s\)\{-}\)\*\//\/\/\1/g //... -> /*...*/(仅限单行) %s/\/\/\(.*\)/\/\*\1\*\//g 原文地址:https://www.cnblogs.com/Gster/p/9240001.html

C注释风格转化为C++风格注释

C转C++可能遇到的问题: //1.一般情况 /* int i = 0; */ // 2.换行问题 /* int i = 0; */ int j = 0; /* int i = 0; */ int j = 0; // 3.匹配问题 /*int i = 0;/*xxxxx*/ // 4.多行注释问题 /* int i=0; int j = 0; int k = 0; */int k = 0; // 5.连续注释问题 /**//**/ // 6.连续的**/问题 /***/ // 7.C++注释问题

java_代码注释风格

<?xml version="1.0" encoding="UTF-8" standalone="no"?><templates><template autoinsert="true" context="constructorcomment_context" deleted="false" description="Comment for crea

修改注释的风格

原文的注释风格如下: 将注释改成 /** comment */ 的风格形式: 方法一: 第一个步骤: 文本变成: 第二个步骤: 文本变成:  方法二: 文本变成: 总结碰到的几个需要注意的问题与知识点,vi环境中: 1.子表达式的括号前面记住要加转义字符,引用子表达式的方法是 "\1","\2","\3" ... 的形式. 2.正则表达式的特殊符号记得转义. 3.%s是查找替换的符号. 4.末尾的"g",表示的是全局替换. 5

GoogleCpp风格指南 7)注释

7 注释 Comments 注释虽然写起来很痛苦, 但对保证代码可读性至关重要; 下面的规则描述了如何注释以及在哪注释; 当然也要记住: 注释固然很重要, 但最好的代码本身应该是文档化self-documenting; 有意义的类型名和变量名, 要远胜过要用注释解释的含糊不清的名字; 你写的注释是给代码读者看的: 下一个需要理解你代码的人, 慷慨些吧, 下一个人可能就是你; 7.1 注释风格 Comment Style Tip 使用 // 或 /* */, 统一就好; // 或 /* */都可以

.net 代码风格规范

声明:内容非原创,转自张子阳博客. 对于为什么是转载,唯一原因就是这东西居然比我整理的好,直接用得了. 1. C# 代码风格要求 1.1注释 类型.属性.事件.方法.方法参数,根据需要添加注释. 如果类型.属性.事件.方法.方法参数的名称已经是自解释了,则不需要加注释:否则必须添加注释. 当添加注释时,添加方式如下图所示: 1.2 类型(类.结构.委托.接口).字段.属性.方法.事件的命名 优先考虑英文,如果英文没有合适的单词描述,可以使用拼音,使用中文是不符合要求的. 唯一可以使用中文的地方是

.NET之美——.Net 项目代码风格要求

.Net 项目代码风格要求 PDF版下载:项目代码风格要求V1.0.pdf 代码风格没有正确与否,重要的是整齐划一,这是我拟的一份<.Net 项目代码风格要求>,供大家参考. 1. C# 代码风格要求 1.1注释 类型.属性.事件.方法.方法参数,根据需要添加注释. 如果类型.属性.事件.方法.方法参数的名称已经是自解释了,不需要加注释:否则需要添加注释. 当添加注释时,添加方式如下图所示: 1.2 类型(类.结构.委托.接口).字段.属性.方法.事件的命名 优先考虑英文,如果英文没有合适的单

项目代码风格要求

1. C# 代码风格要求 1.1注释 类型.属性.事件.方法.方法参数,根据需要添加注释. 如果类型.属性.事件.方法.方法参数的名称已经是自解释了,则不需要加注释:否则必须添加注释. 当添加注释时,添加方式如下图所示: 1.2 类型(类.结构.委托.接口).字段.属性.方法.事件的命名 优先考虑英文,如果英文没有合适的单词描述,可以使用拼音,使用中文是不符合要求的. 唯一可以使用中文的地方是枚举的枚举项,枚举项实际已经不属于本节标题的范畴了.这里只是放到一起说明,如下图所示: 1.3 不使用缩