查看内容

前端编码规范(1)—— 一般规范

  • 2020-01-20 06:56
  • 新浦京编程
  • Views

我们以 HTML 编辑器为例,现在的 HTML 编辑器都做得很好,只需要几个引用,几句 JavaScript 代码,就实现了。但我们发现,其中有很多图片,是由 JavaScript 动态指定的,但我们并没有指定图片路径,它怎么就能正确引用了呢?

一般规范

以下章节列举了一些可应用在 HTML, JavaScript 和 CSS/SCSS 上的通用规则。


比如 .js 文件和图片文件一个目录,但 .js 文件中动态创建 img 时,并不能直接指定文件名,还应该指定路径,应该这个图片的路径不应该是相对于 .js 来说的,而应该是相对于引用之的 html 文件来说有。

文件/资源命名

在 web 项目中,所有的文件名应该都遵循同一命名约定。以可读性而言,减号(-)是用来分隔文件名的不二之选。同时它也是常见的 URL 分隔符(i.e. //example.com/blog/my-blog-entry or //s.example.comig-black-background.jpg),所以理所当然的,减号应该也是用来分隔资源名称的好选择。

请确保文件命名总是以字母开头而不是数字。而以特殊字符开头命名的文件,一般都有特殊的含义与用处(比如 compass[1] 中的下划线就是用来标记跳过直接编译的文件用的)。

资源的字母名称必须全为小写,这是因为在某些对大小写字母敏感的操作系统中,当文件通过工具压缩混淆后,或者人为修改过后,大小写不同而导致引用文件不同的错误,很难被发现。

还有一些情况下,需要对文件增加前后缀或特定的扩展名(比如 .min.js, .min.css),抑或一串前缀(比如 3fa89b.main.min.css)。这种情况下,建议使用点分隔符来区分这些在文件名中带有清晰意义的元数据。

不推荐

  1. MyScript.js
  2. myCamelCaseName.css
  3. i_love_underscores.html
  4. 1001-scripts.js
  5. my-file-min.css

推荐

  1. my-script.js
  2. my-camel-case-name.css
  3. i-love-underscores.html
  4. thousand-and-one-scripts.js
  5. my-file.min.css

它大概是这样做到的:

协议

不要指定引入资源所带的具体协议。

当引入图片或其他媒体文件,还有样式和脚本时,URLs 所指向的具体路径,不要指定协议部分(http:, https:),除非这两者协议都不可用。

不指定协议使得 URL 从绝对的获取路径转变为相对的,在请求资源协议无法确定时非常好用,而且还能为文件大小节省几个字节。

不推荐

  1. <script src=";

推荐

  1. <script src="//cdn.com/foundation.min.js"></script>

不推荐

  1. .example {
  2. background: url();
  3. }

推荐

  1. .example {
  2. background: url(//static.example.comg.jpg);
  3. }

  • 获取所有的 script 标签;
  • 根据 script 标签的 src 所引用的文件名,找出引用当前 .js 文件的 script;
  • 剥离出第二步找到的 script 的 src 路径,这个路径就是相当于当前 html 文件对 .js 文件的路径。

文本缩进

一次缩进两个空格。

  1. <ul>
  2. <li>Fantastic</li>
  3. <li>Great</li>
  4. <li>
  5. <a href="#">Test</a>
  6. </li>
  7. </ul>
  1. @media screen and (min-width: 1100px) {
  2. body {
  3. font-size: 100%;
  4. }
  5. }
  1. (function(){
  2. var x = 10;
  3.  
  4. function y(a, b) {
  5. return {
  6. result: (a + b) * x
  7. }
  8.  
  9. }
  10. }());

示例

注释

注释是你自己与你的小伙伴们了解代码写法和目的的唯一途径。特别是在写一些看似琐碎的无关紧要的代码时,由于记忆点不深刻,注释就变得尤为重要了。

编写自解释代码只是一个传说,没有任何代码是可以完全自解释的。而代码注释,则是永远也不嫌多。

当你写注释时一定要注意:不要写你的代码都干了些什么,而要写你的代码为什么要这么写,背后的考量是什么。当然也可以加入所思考问题或是解决方案的链接地址。

不推荐

  1. var offset = 0;
  2.  
  3. if(includeLabels) {
  4. // Add offset of 20
  5. offset = 20;
  6. }

推荐

  1. var offset = 0;
  2.  
  3. if(includeLabels) {
  4. // If the labels are included we need to have a minimum offset of 20 pixels
  5. // We need to set it explicitly because of the following bug:
  6. offset = 20;
  7. }

一些注释工具可以帮助你写出更好的注释。JSDoc 或 YUIDoc 就是用来写 JavaScript 注释用的。你甚至可以使用工具来为这些注释生成文档,这也是激励开发者们写注释的一个好方法,因为一旦有了这样方便的生成文档的工具,他们通常会开始花更多时间在注释细节上。


  1.  
上一篇:B2B 平台为何如此受热捧 下一篇:没有了