代码规范与目标

这个作业属于哪个课程 2018级计算机和综合实验班
这个作业要求在哪里 第七次团队作业

代码规范

0、代码缩进
前端: 前端代码缩进为 两个制表符
后端:后端代码缩进为 两个制表符

public void main(){
System.out.print("我是内容")
}

1、命名规范
1、java命名规范
1.1、项目名全部小写
1.2、包名全部小写
1.3、类名首字母大写,若类名由多个单词构成,每个单词首字母大写,即驼峰命名法
1.4、变量名、方法名首字母小写,若其由多个单词构成,每个单词首字母大写,即小驼峰命名法
1.5、常量名全部大写
1.6、名称只能由数字、字母、下划线、$符组成,不能以数字开头
1.7、尽量不要使用拼音 或者 英语掺杂拼音(如:StudentDianHua || MyHomeDiZhi 等)

2、前端命名规范
2.1.一律小写;
2.2.尽量用英文(汉字跨域或引入会需要解码,很麻烦);
2.3.尽量不加中杠和下划线;
2.4.尽量不缩写,除非一看就明白的单词,如:wrapper可以写成wrap。
(命名千万要有意义 避免使用 var x= “”;之类的命名)

3、驼峰命名法:
3.1、小驼峰命名:
除第一个单词之外,其他单词首字母大写(常用于变量)
var phoneNumber = 150xxxxxxxx;
3.2、大驼峰命名:(帕斯卡命名法)
var Address = 'xx省xx市xx区xx路';
4、匈牙利命名法
变量属性+ 变量类型 + 变量描述 = 变量名

    类型            对应缩写        对应单词    
    指针             p               Pointer 
    函数             fn              Function
    无效             v               Void
    长整型           l               Long
    实型             r               Real
    无符号           u               Unsigned
    字符             ch              Char
    整型             i               Int
    字节             by              Byte 
    布尔             b               Boolean
    浮点型           f               float 
    字符串           s               String   
    双精度浮点       d               Double
    计数             c               Computed

匈牙利命名 -- 描述(常用)
类型 对应描述
最大值 Max
最小值 Min
初始化 Ini
求和 Sum
添加 Add
删除 Del
更新 Upd
获取 Get
设置 Set
密码 Pwd
5、下划线分割命名法
所有字母都是小写,每个单词之间用下划线分开
var phone_number = 150xxxxxx;
var my_qq_email ="150xxx @qq.com";

6、空行释
写注释,虽然写起来很麻烦,也不能被机器运行,没有什么实际的效果,但 可以清楚的提醒程序员,被注释的这段代码功能是什么,需要传什么参数等等
写注释需要注意
最好不要在注释中使用缩写,特别是用的很少的 不经常使用的缩写。
注释书写时要准确、易懂,不要有二义性。错误的注释只会让你或看这段代码的人多加班
注释的书写的位置最好放在被描述的代码上行,或者右侧
注释:
1、单行注释: // 注释内容
2、多行注释:/* 注释内容 /
3、文档注释:/
* 注释内容 */
4、空行
每写完一个代码功能块,应该空出一行,表示这个代码块已经结束了,后面出现的代码是下一个代码功能块的,与本代码块无关,(不空行也没什么影响,只是空行会让人看起来很舒服)
public String getUserName(){
......
//功能代码实现
......
}

public User getUserPassword ( ){
......
//功能代码实现
......
}

public User getUserById(){
......
//功能代码实现
......
}

预期计划及目标

日期 任务 目标
5月13日 确认项目目标,讨论项目任务分配 已完成
5月14日 各个任务块分别进行 已完成
5月15日 各个任务块分别进行 已完成
5月16日 各个任务块分别进行 已完成
5月17日 各个任务块分别进行 已完成
5月18日 完成项目登录界面 已完成
5月19日 完成打卡功能 已完成
5月20日 完成排行榜 已完成
5月21日 实现前后端连接 未完成
5月22日 实现前后端连接 未完成
5月23日 撰写博客 已完成
posted @ 2021-05-25 22:41  友谊万岁  阅读(81)  评论(2编辑  收藏  举报