1 Star 0 Fork 86

计科三班陈振国/Project-Java

forked from 有朝一日/Project-Java 
加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
代码规范.TXT 4.49 KB
一键复制 编辑 原始数据 按行查看 历史
计科三班陈振国 提交于 2021-04-02 14:09 . 20188472陈振国
1.命名
  可以定义各种标识符作为变量名、数组名、函数名、标号及用户定义对象的名称。标识符由字母和下划线开始,随后可以出现字母、下划线和数字。但是有些关键字不能成为标识符,例如for,int,struct等。 使用标识符命名的惯例,如:全局变量首字母大写、变量或者函数小写字母开头、常量全大写等。
  (1)变量命名
  变量命名时,一个单词或者汉语拼音的一个字一律小写,且尽量使用名词,但是可以使用形容词修饰,用驼峰命名表从属关系。因为变量名作为一个变量的名字,就应该是一个名词(当然由于英语水平的不足,有些不会用英语的名词会用拼音或拼音的首字母代替)。如果变量在整个程序的意义不明,用a,b,c或x,y,z这类作为变量名(尽量少用)。
  局部循环体控制变量用i,j,k等字母表示。如
for(i=0;i<10;i++);
  局部变量尽量用一个单词(或者是拼音)表达清楚其含义。
  (2)数组命名
  数组命名各单词首字母大写(或者拼音首字母大写),但是数组名首字母不用大写(虽然用大写不会编译错误,但是这么做是为了遵循标识符命名首字母小写的原则)。其他的类似于变量命名。例如:
int shuZu[100]
  (3)函数命名
  函数名各单词首字母大写(或者拼音首字母大写),但是函数名首字母不用大写。其他的类似于变量命名和数组命名。
  (4)类命名
  首字母大写,其他的类似于变量命名和函数命名。
  (5)常量命名   所有字母大写,其他的类似于变量命名。
2.每行最多字符数
  以不超过屏幕宽度为准,一般为100个字符。
3.函数最大行数
  根据功能的实现决定,原则上不要超过100行。
4.缩进格式
  缩进时,使用长度为 4个字符的空格或4个字符宽的 Tab 键。换句话说就是缩进空4格。
  缩进是为了看清一个程序块的开始与结束,尤其是程序行数越多时,缩进的作用越大。4个字符的缩进就可以看的清晰,当然就够了。
5.大括号的位置
  习惯性将左大括号放在行尾,而将右大括号放在行首。这样做容易看出是声明还是定义,并且可以节省代码行数。例如:
if (条件){
语句块;
}
else {
语句块;
}
for (……) {
循环体;
}
while (条件){
循环体;
}
do {
循环体;
} while (条件);
修饰符 函数返回类型 function(参数) {
函数体;
}
6. 注释
  注释虽然不影响程序的编译和运行,但会影响读代码改代码的感受。别人看不懂的没有注释的程序,即使程序完全正确,也没什么用,原因在于其不可维护。
  一个程序应当有适当的注释,不要没有注释,也不要过多注释。注释要简洁、有效,才能达到提高程序的可读性的目的。注释必须保证正确,如果注释错误,不如不用注释(因为注释错误容易产生误导)。也不要(也没必要)注释一些无用的东西。
  一般情况下,注释是用来叙述“做什么”的,而不是用来叙述“怎么做”的,因为“怎么做”部分在代码中已经体现的淋漓尽致。而且,要试图避免将注释插在一个函数里面。
  注释一般采取的两种方式:对一个程序块注释和对一行程序注释,以解释该模块的作用和有关的特殊事项。一行内注释尽量使用//,头文件前部的注释使用/* */。
7.空格与空行
  如果没有空行,那么会让自己的程序过于拥挤,影响程序的可读性。有时候运用空行,是为了区分代码块。
  一般情况下,程序块与程序块之间加空行,函数与函数之间加空行。
  空格的使用,可以区分代码中的变量、符号、表达式等。但是一般情况下,依据个人习惯,加空格。例如:
int x = 3 + 5;//加号前后有加空格。
for (int i = 1; i < 5; i++);//for语句后面括号内的分号前没有加空格,分号后有加空格。
  函数名和后面的小括号之间一般不加空格,标识符和后面的小括号之间一般都加空格。例如:
for (int i = 1; i < 5; i++);//for和括号之间有加空格。
System.out.println("HelloWorld");//括号前不加空格。
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
Java
1
https://gitee.com/HazelnutC/project-java.git
git@gitee.com:HazelnutC/project-java.git
HazelnutC
project-java
Project-Java
master

搜索帮助

Dd8185d8 1850385 E526c682 1850385