122
社区成员
发帖
与我相关
我的任务
分享Eight_Real_MAN——代码规范
| 作业课程 | 2302软件工程社区 |
|---|---|
| 作业要求 | 团队作业——Beta冲刺 |
| 团队名称 | Eight_Real_MAN |
| 这个作业的目标 | 展示代码规范 |
| 其他参考文献 | 《构建之法》，《阿里巴巴Java开发手册》 |
目录
- 一、通用规范
- 二、文件名规范
- 三、.wxml文件---页面代码规范
- 四、.wxss文件---页面代码规范
- 五、js文件---页面代码规范
- 六、图片规范
一、通用规范
尽量使用完整的英文描述符
采用适用于相关领域的术语
采用大小写混合使名字可读
尽量少用缩写，但如果用了，要明智地使用，且在整个工程中统一
避免使用长的名字（小于 15 个字母是个好主意）
避免使用类似的名字，或者仅仅是大小写不同的名字
避免使用下划线（除静态常量等）
注释应该增加代码的清晰度
保持注释的简洁
在写代码之前写注释
public class User {
private String userName; // 用户名
private int userAge; // 用户年龄
// 构造方法
public User(String userName, int userAge) {
this.userName = userName;
this.userAge = userAge;
}
// 获取用户名
public String getUserName() {
return userName;
}
}
二、文件名规范
- pages目录下文件名用英文单词命名，多个单词用驼峰命名法，以小写字母开头，尽量不包含数字或者其他字符。
三、.wxml文件---页面代码规范
编码均遵循
XHTML标准,标签、属性、id命名由小写英文、数字和‘_’组成，且所有标签必须闭合，属性值必须用双引号""。避免使用中文拼音尽量简易并要求语义化。
尽可能减少标签嵌套，做到代码层级清晰。
尽量避免在标签上直接写样式。
<!DOCTYPE html>
<html>
<head>
<title>简单示例</title>
</head>
<body>
<div id="container"> <h1>签到小程序</h1>
<p id="intro">这是一个简单示例页面</p>
<ul>
<li><a href="#" id="link1">链接1</a></li>
<li><a href="#" id="link2">链接2</a></li>
</ul>
</div>
</body>
</html>
四、.wxss文件---页面代码规范
class类名必须以字母开头命名，且全部字母为小写，单词之间用下划线"_"连接，且祖先模块不能出现下划线。
<div class="modulename"> <div class="modulename_info"> <div class="modulename_son"></div> <div class="modulename_son"></div> ... </div> </div>若子孙模块超过4级或以上，应考虑在祖先模块内用具有辨识性的独立缩写作为新的子孙模块；
<div class="modulename">
<div class="modulename_cover"></div>
<div class="modulename_info">
<div class="modulename_info_user">
<div class="modulename_info_user_img">
<img src="" alt="">
<!-- 这个时候 miui 为 modulename_info_user_img 首字母缩写-->
<div class="miui_tit"></div>
<div class="miui_txt"></div>
...
</div>
</div>
<div class="modulename_info_list"></div>
</div>
- 使用选择器时，命名比较短的词汇或者缩写的不允许直接定义样式。 如下：
.hd,.bd,.td{};
- 可用上级节点进行限定。 如下：
.recommend-mod .hd{ }
- 多选择器规则之间建议换行，即当样式针对多个选择器时每个选择器占一行。 如下：
button.btn,
input.btn,
input[type="button"] {…};
- 使用z-index属性尽量z-index的值不要超过150（通用组的除外），页面中的元素内容的z-index不能超过10，（提示框等模块除外但维持在150以下），不允许直接使用（999~9999）之间大值。
- 避免使用低效的选择器。如下：
body > * {…};
ul > li > a {…};
#footer > h3 {…};
五、js文件---页面代码规范
函数名前必须注释此函数的参数意义，以及该函数的用途。
注释放在代码上面（上一行），或者后面（下一行），但不要放在代码后面
// （协议中）接收到的时间段总数 var loop; #错误示例 var log; // 注释生命周期函数放前面，自定义函数放在生命周期函数后面，函数之间相隔一行，方法名采用驼峰命名
onHide: function (e) {
},
/**
* xxxx
*/
onUnload:function(){
},
/**
* 函数之间相隔一行
* 自定义函数放在生命周期函数的后面
*/
selfDefinedFunc: function(){
}
- if、while、for、do语句的执行体用"{}"括起来，"{}"格式如下：
if (a==1) {
//代码
};
- 避免额外的逗号。 如下：
var arr = [1,2,3,];
长语句可考虑断行，即一行显示不下，可分行显示。
使用严格的条件判断符。用=== 代替==，用!== 代替!= ，避免掉入== 造成的陷阱 。在==时，则会有一些让人难以理解的陷阱：
<script>
var undefined;
console.log(undefined == null); // true
console.log(1 == true); //true
console.log(2 == true); // false
console.log(0 == false); // true
console.log(0 == ''); // true
console.log(NaN == NaN);// false
console.log([] == false); // true
console.log([] == ![]); // true
</script>
- 下面类型的对象不建议用new构造。
new Number new String new Boolean new Object //用{}代替 new Array //用[]代替
六、图片规范
命名应用小写英文、数字、_组合，便于团队其他成员理解。
图片格式仅限于gif、png、jpg等，单张图片大小最好不要超过100K。
...全文
请发表友善的回复…
发表回复
