自己的代码风格——代码注释

1、头文件的注释：

/*****************************
* @filename:    Utilily.h
* @author:      xxxx
* @version:     1.0
* @date:        2011-9-3
* @describe:    解析Rmcp指令，将其转化为rmtp(V01.01)
* @modification:无
*****************************/

2、函数注释：

/**
* @describe:   将rmcp的客户端请求的监测指令转换为rmtp(V01.01)
* @param[in]:  nStationID 监测站ID
* @param[out]:  cParamCmd Rmtp所需要的启动指令
* @return:     std::string   失败返回空,否则为正真的启动参数指令
* @des:    如：lmapParamValue中frequency的取值为：106MHz, 89.2MHz, 160MHz, 97.1MHz，对应输出参数vFreqOrder的取值为：2, 0, 3, 1。
*/

时间： 2024-10-25 02:42:14

自己的代码风格——代码注释的相关文章

Android Studio迁移代码风格与注释模板

在使用AS中,感觉系统自带的字体的颜色等不是自己想要的,所以就想的自己配置一种喜欢的字体风格,步骤如下:(工作环境为ubuntu14.10,AS为1.3.2) 1.点击File--->Settings--->Editor---->Colors & Fonts,点击Save AS--->重新命名(举例LJStyle) 2.然后可以在Colors & Fonts下拉列表中选中java,配置自己想要的颜色. 3.当需要将你的这个配置导入到其他设备的AS中,点击File--

PHP PSR-2 代码风格规范 (中文版)

代码风格规范本篇规范是 PSR-1 基本代码规范的继承与扩展. 本规范希望通过制定一系列规范化PHP代码的规则,以减少在浏览不同作者的代码时,因代码风格的不同而造成不便. 当多名程序员在多个项目中合作时,就需要一个共同的编码规范,而本文中的风格规范源自于多个不同项目代码风格的共同特性,因此,本规范的价值在于我们都遵循这个编码风格,而不是在于它本身. 关键词 "必须"("MUST")."一定不可/一定不能"("MUST NOT"

python代码风格指南：pep8 中文翻译

摘要本文给出主Python版本标准库的编码约定.CPython的C代码风格参见?PEP7.本文和?PEP 257 文档字符串标准改编自Guido最初的<Python Style Guide>, 并增加了Barry的?GNU Mailman Coding Style Guide的部分内容.本文会随着语言改变等而改变.许多项目都有自己的编码风格指南,冲突时自己的指南为准. 本文给出主Python版本标准库的编码约定.CPython的C代码风格参见PEP7. 本文和PEP 257 文档字符串标准改

PSR代码风格指南

代码风格指南本手册是基础代码规范(PSR-1)的继承和扩展. 为了尽可能的提升阅读其他人代码时的效率,下面例举了一系列的通用规则,特别是有关于PHP代码风格的. 各个成员项目间的共性组成了这组代码规范.当开发者们在多个项目中合作时,本指南将会成为所有这些项目中共用的一组代码规范. 因此,本指南的益处不在于这些规则本身,而在于在所有项目中共用这些规则. RFC 2119中的必须(MUST),不可(MUST NOT),建议(SHOULD),不建议(SHOULD NOT),可以/可能(MAY)等关键

.net 代码风格规范

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

.Net 项目代码风格

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

PHP团队编码规范 & 代码风格规范

一.基本约定 1.源文件 (1).纯PHP代码源文件只使用 <?php 标签,省略关闭标签 ?> : (2).源文件中PHP代码的编码格式必须是无BOM的UTF-8格式: (3).使用 Unix LF(换行符)作为行结束符: (4).一个源文件只做一种类型的声明,即,这个文件专门用来声明Class, 那个文件专门用来设置配置信息,别混在一起写: 2.缩进使用Tab键来缩进,每个Tab键长度设置为4个空格: 3.行一行推荐的是最多写120个字符,多于这个字符就应该换行了,一般的编辑器是可以设

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

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

浅谈Kotlin（二）：基本类型、基本语法、代码风格

浅谈Kotlin(一):简介及Android Studio中配置通过上面的文章,在Android Studio中我们已经可以进行Kotlin编程了,接下来开始学习Kotlin的基本类型及语法. 一.基本类型在 Kotlin 中,所有变量的成员方法和属性都是一个对象. 一些类型是内建的,它们的实现是优化过的,但对用户来说它们就像普通的类一样. 注意,第一个字母大写,Kotlin 区分大小写主要是以下几种字面值常量: --数型: 123 --长整型要加大写 L : 123L --16进制: