规范,最佳实践
W3C规则,规范:
自定义标签名:全部字母都小写,并且包含一个短杠。不是用驼峰命名法。
比如用 <my-hello> ,而不是 <myHello> 或者 <MyHello>
这样设计的原因是 html标准 不区分大小写
项目原则:
前端多传字段给后端可以,但少了不行( 解析的时候有判断是否少了东西)
可以多,因为这样开发人员在测试的时候,可以多传递一些信息给后端,而不报错
swa 生成api文档,立刻协同,添加 修改 方便
前后端传的对象名要一样
ExamPaperQueryParam queryParam,如果前端传ExamPaperQueryParam 对象,对象名为queryParam,我后端一般就只能是queryParam,可以配置
ExamPaperQueryParam examPaperQueryParam
是否
这类 是否 的东西,默认都要为“否”
int isBule=0; //1
boolean isBule = false; //true
HTTP 动词 / 增删改查
HTTP动词 RESTful 规范动词 RestFul
不同协商前后端 控制器的动词,
动作/东西/byID参数
不规范的
增 增加 创建 添加
create
add
increase
删 删除 移除
delete
remove
改 更新
update
set
查 查找 查询 读取
get
find
search
中文英文名词要统一
图片
pic
pictrue
photo
显示
show
display
手机号
phone
phone number
phone TelNumber
申请 报考
apply
dreamSchool 报考学校
试题 , 用 问题question 表示
QUESTION
真题
Past exams
reward 英[rɪˈwɔ:d] 美[rɪˈwɔ:rd]
n. 报酬; 报答; 赏金; 酬金;
命名规范
包名驼峰命名法
思路
别出现魔法数字
“重构”不只是简单的“改代码”
改代码包括 改BUG,但 改BUG 不是重构
重构 我是理解为 优化代码:
让可读性 或 运行效率更高
posted on 2017-03-26 16:47 xiaoCong2015 阅读(185) 评论(0) 编辑 收藏 举报