我的代码格式

原创 2007年09月11日 18:01:00
1. 在.h/.cpp的开头应有一段格式统一的说明,格式如下:
// 
//
// 文 件 名:
// 简    述:
//  作    者:OutSky
// 最后更新:xxxx年xx月xx日
/////////////////////////////////////////////////////////////////////////////

2.对于主要功能函数应有注释说明。格式为:
 
/////////////////////////////////////////////////////////////////////////////
//    函 数 名:    
//    简    述:    
//    参    数:(参数名、意义)
//    返 回 值:(返回值类型、意义)
//    注    意:(需要注意的信息)
/////////////////////////////////////////////////////////////////////////////


3. 每列代码的长度推荐为80列,最长不得超过120列;折行以对齐为准。
例:HANDLE KSOpenFile(const char cszFileName[], 
int nMode); 
或者: 
BOOL KSReadFile( 
HANDLE hFile, 
void *pvBuffer, 
int nReadSize, 
int *pnReadSize 
); 

4. 循环、分支代码,判断条件与执行代码不得在同一行上。
例:正确: 
if(-2 == n) 
    n 
= 1
else 
    n 
= 2
不得写做: 
if (-2 == n) n = 1
else n = 2

5. 指针的定义,* 号紧接变量名。
例:正确:
int *pNum;
错误1:
int* pNum;
错误2:
int * pNum;
6.返回指针时,*号紧跟返回值类型。
例:正确:
int* fun();
错误1:
int *fun();
错误2:
int * fun();


7. 函数入口参数有缺省值时,应注释说明。
例: 
BOOL KSSaveToFile( 
const char cszFileName[], 
BOOL bCanReplace 
/**//* = TRUE */ 
); 
8. else if 必须写在一行。
9.‘{’必须另起一行。‘{’与‘}’必须在同一列上。类中定义的内联函数等特殊情况除外。
例:正确: 
if (i > 0
...
= 1
n
++
}
 
不得写做: 
if (i > 0...
= 1
n
++
}
 

 

10.if语句、while语句格式:
情况1:条件只有一个,则在条件语句两侧各空一格,如:
if( a<b )
while( a<b )
情况2:条件多于一个,则条件之间空格,两侧不空格,如:
if(a<&& d<c)
while(a<&& d<c)
11.for语句格式:
空格位置如例:
类型1: 
for(int a=0; a<10++a)
类型2: 
for(a=0, b=1; a<10&&b<10++a,++b)
12.普通注释格式:
情况1:注释内容较少,所要注释的代码也很短。注释放在代码同一行的右边。
int nNum;    // 小球的个数
情况2:注释内容不多,但所要注释的代码很长。注释放在代码上一行。
// 所有物品的总数
int nNum = nNumObjA+nNumObjB+nNumObjC+......
情况3:注释的内容很多,放在代码上面,用
/**//* */注释。
/**//*
1.什么什么什么
2.什么什么什么
3.。。。
*/

继续添加。。。

NetBeans的格式化代码风格,编辑代码风格,统一代码格式

写完代码,想要统一代码的格式 1)打开NetBeans编辑器,点击工具栏 2)选择选项,点击编辑器 3) 选择格式设置,即可设置代码的风格,格式。 4)设置代码模板,下一次写代...
  • qiujin_zebra
  • qiujin_zebra
  • 2017年06月13日 10:17
  • 1688

Javadoc文档注释使用方法

在Java里面主要有三种注释:行注释、段落注释、文档注释 这里主要说第三种:文档注释 文档注释是Java里面的一个比较厉害的功能,它可以用于注释类、属性、方法等说明,而且通过JDK工具javado...
  • Listener_ri
  • Listener_ri
  • 2015年04月22日 09:27
  • 4800

【记录】数控程序的指令代码---标准G代码与标准M代码

原文地址: 数控机床的运动是由程序控制的,而准备功能和辅助功能是程序段的重要组成部分,也是程序编制过程中的核心问题。目前国际上广泛应用的是ISO标准,我国根据ISO标准制订了JB/T3208-199...
  • jiasike
  • jiasike
  • 2014年11月08日 12:52
  • 10014

Web UI自动化测试框架搭建之七:代码格式

当代码要共享时,需要规范代码格式,可以去网上搜索好用的代码格式,我找到了下面的google java style Step 1: Download the Google Java Sty...
  • lixiuhua_2012
  • lixiuhua_2012
  • 2017年12月29日 19:24
  • 57

将RGB图像数据压缩成jpg格式图片的代码实现

#include #define JPEG_QUALITY 100 //图片质量 int savejpg(uchar *pdata, char *jpg_file, int width, int ...
  • chyxwzn
  • chyxwzn
  • 2012年12月27日 15:49
  • 9138

C/C++代码命名和格式规范

命名 命名,包括文件名、类名、结构名、类型名、函数名、变量名、参数名等都是程序设计中重要的一部分。一个好的名称,体现了一个深思熟虑的过程,同时也能够帮助别人更好地理解开发者的思路。如果发现程序中...
  • f_zyj
  • f_zyj
  • 2016年06月06日 16:46
  • 2816

Intellij IDEA中通过Live Templates快速生成一段固定格式的代码,如:文本注释等。

在Intellij IDEA中,如果想要快速生成一段代码,比如如下代码。 /** * Created with IntelliJ IDEA * Created by ustcck on 2016...
  • ck4438707
  • ck4438707
  • 2016年10月30日 23:12
  • 2661

生成符合flexigrid的json格式的java代码

public class FlexGridJSONData {     private int page=1;     private int total=0;     private List...
  • guirudaoge
  • guirudaoge
  • 2011年11月13日 08:03
  • 4719

wav文件格式分析详解和解析代码

wav文件格式分析详解和解析代码
  • niehanzi
  • niehanzi
  • 2011年08月05日 18:26
  • 1135

《代码整洁之道》摘录---格式

团队应该一致同意采用一套简单的格式规则,可以运用将这些规则自动化的工具。 代码格式关乎沟通,而沟通是专业开发者的头等大事。 或许你认为“让代码能工作”才是专业开发者的第一优先级。你今天编写...
  • HorkyChen
  • HorkyChen
  • 2011年04月16日 15:29
  • 1852
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:我的代码格式
举报原因:
原因补充:

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