您的位置: 首页  >  IT文章  >  代码规范(RL-TOC)用更合理的方式写 JavaScript

代码规范(RL-TOC)用更合理的方式写 JavaScript

分类: IT文章 • 2022-08-29 23:11:46

  • 代码可以改变世界
  • 不规范代码可以毁掉世界
  • 只有先学会写规范的代码，才可以走的更远

编程语言之间有很多编程规范都是通用:

命名

  • 不要用语言不明的缩写，不用担心名字过长，名字一定要让别人知道确切的意思;
  • 类、类型、变量用名词或组合名词。如Member, ProductInfo;
  • 函数名用动词或者动宾组合词来表示，如get/set，RenderPage();
  • 布尔变量需要用is做前缀;
  • 尽量写绝对路径;

注释

  • 注释是为了解释程序做了什么(What)或者为什么这么做(Why)，以及要特别注意的地方；
  • 注释不是为了解释程序如何工作的(How)；
  • 最高境界：程序本身就应该能说明，如果程序需要额外的注释，那说明这段代码写的很烂；
//一般注释
------------------------------------------------
/*
 *
方法注释
*/

Pascal - 所有单词的首字母都大写;
Camel - 第一个单词首字母小写，其他单词首字母大写;

HTML

  • HTML 问件的命名用Pascal【所有单词的首字母都大写 】的命名方式;
  • Class命名用小写字母连字符(-)来连接命名的不同单词;
  • ID命名用小写字母连字符(-)来连接命名的不同单词;

CSS

.ui-list{}

#btn-open-main-page{}
  • css/less文件名用连字符(-)来连接不同单词。
  • 样式用连字符(-)来连接命名的不同单词。
  • 从外部文件加载css，尽可能减少文件数。加载标签放在文件的head部分;
  • 页面中少量的样式放在head的style标签内，大量的样式可以提取到外部的css文件中,不要使用内联式样式;
  • 编写性能优化的选择器。避免使用开销大的CSS选择器，比如*;

JavaScript

  • js文件的命名，用连字符(-)来连接文件名中的不同单词。如user-handler.js；
  • 将99%的代码放在外部js文件中，放在</body>的前边，让页面的性能最大化；
  • 属性，方法均采用Camel【所有单词的首字母都大写】形式；
  • 对象的构造函数(var变量)采用Pascal【第一个单词首字母小写，其他单词首字母大写】形式；
var globalVariable = 'I am Global Variable';
function Person(name,age) {
  this.name = name;
  this.age = age;
  this.sayHi = function() {
    console.log('Hi, I am ' + this.name + ' ' + this.age + ' years old.');
  }
}

images命名：

  • 用小写字母和连字符(-)来连接命名的不同单词。

【参考】

纯属个人观点,仅供参考

相关推荐