结对作业二之代码规范

前端:Angular代码规范

该代码规范节选自Angular官方文档的风格指南

利用四个空格或者一个Tab进行缩进
每行最大长度不超过100
坚持使用大写驼峰命名法来命名类
坚持每个文件只定义一样东西(例如服务或组件)
坚持定义简单函数(Do define small functions)考虑限制在 75 行之内,完成单一的功能
坚持所有符号使用一致的命名规则。坚持遵循同一个模式来描述符号的特性和类型。例如 feature.type.ts
坚持在描述性名字中,用横杠来分隔单词。坚持使用点来分隔描述性名字和类型
url的命名尽量与功能模块相匹配
坚持按功能划分Module,并在每个功能Module中单独定义需要的组件
坚持利用服务为所有组件提供统一化的接口,例如发送请求、存储数据。

后端:Flask代码规范

该代码规范节选自Pocoo团队编码风格指南,该团队为Flask社区官方开发团队。

4个空格。不能使用Tab制表符,没有例外。
每行最大长度。79个字符,如果必要可以接受最多84个字符。尽量避免代码嵌套层级过多,可以通过巧妙地使用break、continue和return语句实现
编写长语句时,可以使用换行符(\)换行。在这种情况下,下一行应该与上一行的最后一个“.”句点或“=”对齐,或者是缩进4个空格符。
空行。顶层函数与类之间空两行,此外都只空一行。不要在代码中使用太多的空行来区分不同的逻辑模块。
一般空格规则。单目运算符与运算对象之间不空格(例如,-,~等),即使单目运算符位于括号内部也一样。双目运算符与运算对象之间要空格。
不能编写尤达语句(Yoda Statements,指的是类似星战中尤达大师那样颠倒句子的正常顺序)。
命名规范:
类名称:采用骆驼拼写法(CamelCase),首字母缩略词保持大写不变(HTTPWriter,而不是HttpWriter)。
变量名:小写以及下划线(lowercase_with_underscores)。
方法与函数名:小写以及下划线(lowercase_with_underscores)。
常量:大写以及下划线(UPPERCASE_WITH_UNDERSCORES)。

posted @ 2021-03-31 18:37  Fino-  阅读(58)  评论(0编辑  收藏  举报