代码规范
来源:互联网 发布:nvsip软件下载 编辑:程序博客网 时间:2024/05/20 20:21
看了一眼老夫之前写的代码,看见代码里密密麻麻标的标注觉得好搞笑,是时候反思一下自己了。遵循代码规范:
有点纠结,我是一个特别喜欢在代码中写注释的人,但是写完感觉有点乱,看了一些前辈的博客的代码风格,简洁明了,看来我是要给自己一套代码,交给我的小伙伴的时候要把密密麻麻的注释删掉,精简,告诉小伙伴代码在干什么。
HTML,JavaScript和CSS/SCSS通用的原则:
文件/资源命名
在 web 项目中,所有的文件名应该都遵循同一命名约定。以可读性而言,减号(-)是用来分隔文件名的不二之选。同时它也是常见的 URL 分隔符(
i.e. //example.com/blog/my-blog-entry or //s.example.com/images/big-black-background.jpg
),所以理所当然的,减号应该也是用来分隔资源名称的好选择。
请确保文件命名总是以字母开头而不是数字。而以特殊字符开头命名的文件,一般都有特殊的含义与用处(比如 compass[1] 中的下划线就是用来标记跳过直接编译的文件用的)。
资源的字母名称必须全为小写,这是因为在某些对大小写字母敏感的操作系统中,当文件通过工具压缩混淆后,或者人为修改过后,大小写不同而导致引用文件不同的错误,很难被发现。
还有一些情况下,需要对文件增加前后缀或特定的扩展名(比如 .min.js, .min.css),抑或一串前缀(比如 3fa89b.main.min.css)。这种情况下,建议使用点分隔符来区分这些在文件名中带有清晰意义的元数据。
协议
不要指定引入资源所带的具体协议。
当引入图片或其他媒体文件,还有样式和脚本时,URLs 所指向的具体路径,不要指定协议部分(http: , https:),除非这两者协议都不可用。
不指定协议使得 URL 从绝对的获取路径转变为相对的,在请求资源协议无法确定时非常好用,而且还能为文件大小节省几个字节。
文本缩进
一次缩进两个空格。
注释
注释是你自己与你的小伙伴们了解代码写法和目的的唯一途径。特别是在写一些看似琐碎的无关紧要的代码时,由于记忆点不深刻,注释就变得尤为重要了。
编写自解释代码只是一个传说,没有任何代码是可以完全自解释的。而代码注释,则是永远也不嫌多。
当你写注释时一定要注意:不要写你的代码都干了些什么,而要写你的代码为什么要这么写,背后的考量是什么。当然也可以加入所思考问题或是解决方案的链接地址。
- 代码规范
- 代码规范
- 代码规范
- 代码规范
- 代码规范
- 代码规范
- 代码规范
- 代码规范
- 代码规范
- 代码规范
- 规范代码
- 代码规范
- 代码规范
- 代码规范
- 代码规范
- 代码规范
- 代码规范
- 代码规范
- mysql重置密码
- Boost的安装
- UML基础之组合与聚合关系
- pycharm中光标变粗
- java 判断对象的所有属性是否为空解决方案
- 代码规范
- 【预告:直播回顾&资料下载】2017阿里巴巴双11技术十二讲,历数双11精彩技术干货
- 事件流(事件冒泡、事件捕获以及DOM事件流)
- java实现观察者模式
- Android中常见的异常及原因
- S5PV210开发 -- I2C 你知道多少?(二)
- clock_gettime系统调用详解
- 信息管理(单链表)
- TCP三次握手流程及为什么是三次握手