规范
大娱乐家cpy
生生灯火,明暗无辄。
展开
-
软件版本信息定义规则
软件版本信息定义规则前言:阅读这篇文章我能学到什么? 如果你正为软件版本迭代得越来越多烦恼,或者想寻找更规范的版本定义,那么请阅读这篇文章,也许你会有启发。——如果你觉得这是一篇不错的博文,希望你能给一个小小的赞,感谢您的支持。目录软件版本信息定义规则1 软件版本信息码1.1 协议名/产品名(A)1.2 系列号(B)1.3 主版本号(C\)1.4 副版本号(D)1.5 子本号(E)1.6 日期版本号(F)1.7 阶段版本号(G)2 释意举例说明3 更新版本信息规则3.1 旧项目变更3.2 新项目原创 2020-05-10 13:09:12 · 1849 阅读 · 1 评论 -
github issue提交Bug的格式
github issue提交Bug的格式github早已在国内程序员中流行起来,我们经常会访问github上别人的源码或使用别人提供的插件,有时候会发现一些Bug希望作者能将其改进,这时候就可以考虑提交issue。遇到问题就该立刻给作者提交issue吗?当我们使用github上的开源代码或工具发现bug时,别急先仔细阅读文档也许是我们使用方法不对,或文档上有解决问题的信息。如果已经仔细查阅文...原创 2020-03-24 16:03:49 · 4366 阅读 · 4 评论 -
CSDN_Markdown语法
CSDN_Markdown语法这篇文章将CSDN的Markdown语法进行汇总,便于查询和保存本地文件查看。目录CSDN_Markdown语法目录标题一级标题二级标题三级标题四级标题五级标题六级标题文本列表链接代码片表格脚注注释自定义列表LaTex公式序列图Mermaid流程图Flowchart流程图目录会自动提取后文中以#开头的标题将其作为文章导航目录。语法格式:@[toc](目...原创 2020-03-19 14:34:04 · 429 阅读 · 4 评论 -
c代码文件内布局规范
c代码文件内布局规范*.h文件内代码布局规范文件头注释。文件条件编译宏。头文件包含。结构体定义。联合定义。枚举定义。宏定义。全局变量声明。全局函数声明。宏函数定义。*.c文件内代码布局规范文件头注释。头文件包含。变量定义(按类型分类,从占字节少到字节多,然后是结构体、联合、枚举变量)。函数定义。...原创 2020-03-10 16:39:37 · 376 阅读 · 0 评论 -
c代码命名规范
c代码命名规范##变量命名命名前缀//类型宏定义,为了屏蔽不同芯片库文件的变量类型名称不一致,增强可移植性typedef _Bool Bool; //!< 布尔类型变量,变量命名时前缀加btypedef uint8_t Byte; ...原创 2020-03-10 16:37:35 · 648 阅读 · 0 评论 -
c代码Doxygen注释规范
c代码Doxygen注释规范前言:良好得注释风格利于后期维护和团队协作开发,使得代码逻辑清晰,意图明了。Doxygen是一种能自动提取代码内注释生成版主文档的开源软件,它是跨平台的。非开源项目也许并不需要有这样一份帮助文档,但Doxygen的注释规范也不失为一种好的风格,可以推广遵守。Doxygen注释规范模板文件注释模板/** * @file 文件名(*.h/*.c) * @b...原创 2020-03-10 16:27:01 · 5224 阅读 · 0 评论 -
SVN软件开发日志规范
SVN 软件开发日志规范前言:写代码的好习惯除了言简意赅的注释外,还有完善且必要的日志。注释主要是对代码内的模块或功能函数、算法、逻辑框架等进行必要简明的说明,它关注的是”这个“代码里做了什么。而日志需要说明的是这版代码和上一版本改了什么(重点关注代码的升级迭代、用途、风险),和其他代码有啥关系(比如关注是否某些功能模块借鉴或移植于其他项目)。所以日志主要关注的是“这些”代码之间的关系(改动、移...原创 2020-03-04 12:51:49 · 875 阅读 · 1 评论