MiniSNS-代码规范

xiaoxiao2021-02-28  35

JS代码规范 1注释 代码注释需要说明“函数功能”、“入口参数”、“返回值”

2 类型、字段、属性、方法、事件的命名

统一使用英文。如果实在找不到合适描述可以使用中文但必须是全拼。使用中文是不符合要求的。 命名规范统一使用驼峰法(函数名中的每一个逻辑断点都有一个大写字母来标记)。并且所有类型、方法、参数、变量的命名不得使用缩写,包括大家熟知的缩写,例如msg。 3、 使用Tab作为缩进,并设置缩进大小为4 4、 如果if语句内容只有一行,可以不加花括号,但是必须和if语句位于同一行 5、前缀规范: 每个局部变量都需要有一个类型前缀,按照类型可以分为:

s:表示字符串。例如:sName,sHtml; n:表示数字。例如:nPage,nTotal; b:表示逻辑。例如:bChecked,bHasLogin; a:表示数组。例如:aList,aGroup; r:表示正则表达式。例如:rDomain,rEmail; f:表示函数。例如:fGetHtml,fInit; o:表示以上未涉及到的其他对象,例如:oButton,oDate; g:表示全局变量,例如:gUserName,gLoginTime

CSS 代码风格要求

1、避免重复定义

重复的属性尽可能避免重复定义,而需要分组定义元素的属性。如果您的h1和h2元素都是使用相同的字体大小、颜色、和边框等,他们完全和可以合并成组定义。 2、 使用Tab作为缩进,并设置缩进大小为4 3、 结构、样式、行为分离 尽量确保文档和模板只包含 HTML 结构,样式都放到样式表里,行为都放到脚本里。 4、Class 和 ID 使用语义化、通用的命名方式; 使用连字符 - 作为 ID、Class 名称界定符,不要驼峰命名法和下划线; 避免选择器嵌套层级过多,尽量少于 3 级; 避免选择器和 Class、ID 叠加使用; 出于性能考量,在没有必要的情况下避免元素选择器叠加 Class、ID 使用。 元素选择器和 ID、Class 混合使用也违反关注分离原则。如果 HTML 标签修改了,就要再去修改 CSS 代码,不利于后期维护。 5、媒体查询(Media query)的位置 将媒体查询放在尽可能相关规则的附近。不要将他们打包放在一个单一样式文件中或者放在文档底部。

转载请注明原文地址: https://www.6miu.com/read-850021.html

最新回复(0)