JavaScript 样式指南

请始终为您所有的 JavaScript 项目使用相同的代码约定。

JavaScript 代码约定

代码约定(Coding conventions)指的是编程的样式指导方针。这些原则大体上包括：

  • 变量和函数的命名和声明规则
  • 使用空格、缩进和注释的规则
  • 编程习惯和准则

Kundin codu.Tattara dokar.:

  • Kara haɗa da ɗaukar codu a cikin sha'awar.
  • Kara haɗa da ɗaukar codu a cikin sha'awar.

Kundin codu za a iya kasancewa doka ce kuma yadda tawagin zai tabbatar da shi, ko kuma amfani da kundin kwarin wanda ke da tasiri kan kwarin kwarin kwarin.

Dakin na kwanan shafi ne kira da CodeW3C.com yin amfani da kundin JavaScript da ake amfani da shi.

Kuwanan kawuwarin bincike 'Best Practices' domin kawuwarin haka kuma yadda a zai iyalin kudiya'war codu.

变量名

在 CodeW3C.com，我们对标识符名称（变量和函数）使用了驼峰式大小写。

所有名称以字母开头。

在本页的底部，我们会更广泛地讨论命名规则。

firstName = "Bill";
lastName = "Gates";
price = 19.90;
tax = 0.20;
fullPrice = price + (price * tax);

运算符周围的空格

请始终在运算符（ = + - * / ）周围以及逗号之后添加空格：

Karamin

var x = y + z;
var values = ["Volvo", "Saab",  "Fiat"];

代码缩进

请始终使用对代码块缩进使用 4 个空格：

函数

function toCelsius(fahrenheit) {
    return (5 / 9) * (fahrenheit - 32);
}

请不要对缩进使用制表符。不同的编辑器对 tab 的解释也不尽相同。

语句规则

简单语句的通用规则：

请始终以分号结束单条语句：

Karamin

var values = ["Volvo", "Saab",  "Fiat"];
var person = {
    firstName: "Bill",
     lastName: "Gates",
    age: 50,
    eyeColor:  "blue"
};

针对复杂语句（compound）的通用规则：

  • 请在第一行的结尾处写开括号
  • 请在开括号前使用一个空格
  • 请在新行上写闭括号，不带前导空格
  • 请不要以分号来结束复杂语句

函数：

function toCelsius(fahrenheit) {
    return (5 / 9) * (fahrenheit - 32);
}

循环：

for (i = 0; i < 5; i++) {
    x += i;
}

条件：

if (time < 20) {
    greeting = "Good day";
} else {
     greeting = "Good evening";
}

对象规则

针对对象定义的通用规则：

  • 把开括号与对象名放在同一行
  • 在每个属性与其值之间使用冒号加一个空格
  • 不要在最后一个属性值对后面写逗号
  • 请在新行上写闭括号，不带前导空格
  • 请始终以分号结束对象定义

Karamin

var person = {
    firstName: "Bill",
    lastName: "Gates",
    age: 19,
    eyeColor:  "blue"
};

a ba cikin abin shirin abin, kawaiya kawaiya ne, dake na atawa dake na:

var person = {firstName:"Bill", lastName:"Gates", age:50, eyeColor:"blue"};

行长度小于 80

为了提高可读性，请避免每行的长度超过 80 个字符。

如果 JavaScript 语句超过一行的长度，换行的最佳位置是运算符或逗号之后。

Karamin

document.getElementById("demo").innerHTML =
    "Hello Kitty.";

Kama a kaiwa saman amfani da shi a yawon hanyar

Kwamfani a kaiwa saman amfani da

Kwamfani a kaiwa saman amfani da kowace abin da ake koyar da kowace abin da ake koyar da. Misali:

  • sunan abin da yana amfani da kuma sunan abin da yana yin aiki daAlama mai kaiwa daban daban (camelCase)don yin
  • Kwamfani a kaiwa saman amfani da global variablekaiwa daban daban(wanda ba a koyar da shi ba, amma yana kaiwa saman wucin gani)
  • Kwamfani (masu koyarwa daban daban) a kaiwa saman amfani dakaiwa daban daban

Kwamfani a kaiwa saman amfani da sunan abin a cikin mai amfani daHyphens,Alama mai kaiwa daban daban (camelCase)koAlama mai kaiwa daban dabanka?

Wannan abin da masu koyarwa sukan yin tarura. Jumla ta fiyace ga wanda ake jumla:

Hyphens a cikin HTML da CSS:

Abin HTML5 zai kaiwa saman kama a koyar da data- (data-quantity, data-price).

CSS a yin amfani da hyphens a cikin sunan abin (font-size).

Hyphens zai kaiwa saman amfani da abin baiyawa. JavaScript ba a koyar da amfani da hyphens ba.

Alama mai kaiwa daban daban:

Manyan masu koyarwa sukan amfani da alama mai kaiwa daban daban (date_of_birth), kuma a cikin database na SQL.

Alama mai kaiwa daban daban sukan amfani da PHP a cikin abin littafai.

Pasca kashe (PascalCase):

Masu koyarwa na C sukan amfani da Pasca kashe.

Alama mai kaiwa daban daban (camelCase):

JavaScript, jQuery da sauran librayan JavaScript a yin amfani da alama mai kaiwa daban daban (camelCase).

Kama a yin amfani da $ a koyar da sunan JavaScript, zai kaiwa saman cikakkiyar abin da zai kaiwa saman kuma yana zubar da sunan JavaScript.

A kama a yin amfani da JavaScript a cikin HTML

A kama a yin amfani da yadda da yafi daban don samun sabon abin JavaScript (abin type ba a koyar da shi ba):

<script src="myscript.js"></script>

Kama a yin amfani da abin HTML

Dakarun kai na HTML na ba da cikakkiyar abin da zai kaiwa saman kuma yana zubar da JavaScript.

Kwamfani daban-daban na yadda JavaScript na zai zubar da zubar yana zubar da zubar daban:

var obj = getElementById("Demo")
var obj = getElementById("demo")

Kamfani a kai, kama anfani, za a cikakar kuma yadda a yin a kan HTML (sai kan JavaScript).

访问 HTML 样式指南。

文件扩展名

HTML 文件应该使用 .html 扩展名（而非 .htm）。

CSS 文件应该使用 .css 扩展名。

JavaScript 文件应该使用 .js 扩展名。

使用小写文件名

大多数 web 服务器（Apache、Unix）对文件名的大小写敏感：

london.jpg 无法视作 London.jpg 进行访问。

其他 web 服务器（微软的 IIS）对大小写不敏感：

london.jpg 能够以 London.jpg 或 london.jpg 来访问。

如果您混合使用大小写，则必须严格保持连续和一致。

如果您将站点从大小写不敏感的服务器转移至对大小写敏感的服务器，即使这种小错误也可能破坏您的网站。

为了避免这些问题，请始终使用小写文件名（如果可能）。

性能

计算机不会使用代码约定。大部分规则对程序的执行影响很小。

缩进和额外的空格对小段脚本并不重要。

对于开发中的脚本，应该优先考虑可读性。应该缩小更大型的生产脚本。