个人代码规范

原创 2018年04月16日 14:40:57

1.文件注释

1)要求
至少要包含文件名称、文件作用说明、编码人、版本号、最后修改时间。

2)举例
源文件
/******************************************************************************                                
* 名    称:        move_power.c                   
* 功    能:        移动电源的通信协议           
* 作    者:        neha
* 版 本 号:       v1.0                                              
* 修改时间:        2018.4.16           
******************************************************************************/  

头文件
/******************************************************************************                                
* 名    称:        move_power.h                   
* 功    能:        移动电源的通信协议的头文件            
* 作    者:        neha      
* 版 本 号:       v1.0                                                  
* 修改时间:        2018.4.16           
******************************************************************************/    

2.类型的宏替换

1)要求
要求用“#ifndef”判断是否之前被定义过。

2)举例
#ifndef uint8       
typedef unsigned char uint8;       
#endif               

3.宏定义

1)要求
宏全为大写的英文字母。
宏的名称应能读出其功能作用。

2)举例
#define MOVE_POWER_FALSE     0    
#define MOVE_POWER_TRUE      1  

4.函数注释

1)要求
至少要包含函数名称、函数作用说明、形参含义、返回值含义。

2)举例
/****************************************************************************
* 函 数 名: move_external_current()
* 功    能: 获取充电器输入的电流值
* 入口参数: *current 指向电流值的指针
* 出口参数: SUCCESS or FAILUR 正确或错误
****************************************************************************/  
static uint8 move_external_current( uint32 *current )
{
    uint8 stat = SUCCESS;

    *current = move_charge.vbus_current;

    return stat;
}




【吴刚】个人网站设计零基础入门标准视频教程

本套教程在学员有PS软件基础及对网页元素制作有了解的基础上,循序渐进,深入浅出,全篇干货,系统化的讲解个人网站设计流程、个人网站设计的特点,以及通过实际个人网站设计案例实操,结合web端的用户交互使用规范,以及相关的技术实现方法手把手教授学生个人网站设计的首屏、主页设计及二级页设计等各方面个人网站设计设计内容及设计规则。
  • 2018年03月23日 17:29

代码规范总结

代码规范总结 作者:bullbat        看了看博客里面上一篇原创文章的时间,甚是惭愧。这大半年时间里,都忙着七七八八的事情,技术上关心的渐少,但最近的几件事情让我对代码规范的重要性有了更深...
  • bullbat
  • bullbat
  • 2013-07-07 21:18:06
  • 10055

Google 开源项目风格指南_中文版

  • 2016年01月08日 15:58
  • 1.24MB
  • 下载

C# 代码规范

  • 2017年10月26日 16:07
  • 246KB
  • 下载

代码规范代码规范

  • 2018年01月15日 20:16
  • 31KB
  • 下载

代码规范代码规范代码规范代码规范

  • 2010年08月28日 13:05
  • 76KB
  • 下载

iOS学习:iOS代码规范

作者感言 阅读前言 iOS代码规范 Import规范 Define规范 Paragma Mark 规范 Interface规范 implementation规范 实例规范 NSDictionary规范...
  • qq350116542
  • qq350116542
  • 2016-04-27 12:41:03
  • 4682

个人的Java代码规范

之前为工作室写过一本代码书写规范的小手册,但是其中多是变量、函数的命名,还有region、summary等的应用,今天看到一老外的代码结构,觉得不错,实行拿来主义,将它变成我的,稍作修改,下面是我的整...
  • AngusSL
  • AngusSL
  • 2011-10-31 10:56:46
  • 1054

【经验交流】香瓜的个人代码规范

本文简要讲述香瓜编码的代码规范
  • feilusia
  • feilusia
  • 2016-12-23 15:06:37
  • 2798

华为代码规范

  • 2017年09月22日 14:30
  • 334KB
  • 下载
收藏助手
不良信息举报
您举报文章:个人代码规范
举报原因:
原因补充:

(最多只允许输入30个字)