|
|
注：本文轉載自 developerworks
作者：王丹丹，高級軟件工程師，IBM
簡介： JavaScript 編程語言作為最流行的客戶端腳本語言，早已被眾多 Web 開發人員所熟悉。隨著 Web2.0 時代的到來和 Ajax 技術的廣泛應用，JavaScript 也逐漸吸引著更多的視線。工作中要求越多的是對 JavaScript 語言的深入學習，靈活運用，和對編碼質量的保證。
對于熟悉 C/C++ 或 Java 語言的工程師來說，JavaScript 顯得靈活，簡單易懂，對代碼的格式的要求也相對松散。很容易學習，并運用到自己的代碼中。也正因為這樣，JavaScript 的編碼規范也往往被輕視，開發過程中修修補補，最終也就演變成為后續維護人員的惡夢。軟件存在的長期價值直接與編碼的質量成比例。編碼規范能幫助我們降低編程中不必要的麻煩。而 JavaScript 代碼是直接發送給客戶瀏覽器的，直接與客戶見面，編碼的質量更應該受到關注。
本文淺談 JavaScript 編程中關于編碼規范的問題，分析其中緣由。希望引起更多 Web 開發人員對 JavaScript 編碼規范問題的關注和對軟件產品質量問題的重視。
前言
提及 C/C++ 和 Java 編碼規范，相信許多工程師并不生疏。但說到 JavaScript 語言的編碼規范，也許您會忍俊不禁。JavaScript 不是語法很靈活嗎？變量隨時用隨時可以聲明；語句結束符可以不要；字符串和數字也可以相加；參數多一個少一個也不會報錯。沒錯，當您從 C/C++ 和 Java 嚴格的語法規定之下，轉向 JavaScript 語言，會覺得自由了很多，輕松了很多。語法松散是 JavaScript 重要的特征。它靈活易懂，給開發人員帶來了很多方便，但如果編寫過程中不注意，代碼的調試成本和維護成本則會無形地增加。
JavaScript 編碼會隨應被直接發送到客戶端的瀏覽器，代碼規范不只是代碼質量的保證，也影響到產品的長期信譽。希望 JavaScript 編程語言的規范問題也能同樣引起更多朋友的關注。
JavaScript 編碼規范建議
本文就 JavaScript 編碼過程中涉及的排版、命名、聲明、作用域、及一些特殊符號的使用等方面，根據個人在學習工作中的總結，給出自己的一些建議，并分析其中緣由，以供參考。
JavaScript 文件引用
JavaScript 程序應該盡量放在 .js 的文件中，需要調用的時候在 HTML 中以 <script src="filename.js"> 的形式包含進來。JavaScript 代碼若不是該 HTML 文件所專用的，則應盡量避免在 HTML 文件中直接編寫 JavaScript 代碼。因為這樣會大大增加 HTML 文件的大小，無益于代碼的壓縮和緩存的使用。
另外，<script src="filename.js"> 標簽應盡量放在文件的后面。這樣會降低因加載 JavaScript 代碼而影響頁面中其它組件的加載時間。
代碼排版
行長度
每行代碼應小于 80 個字符。如果代碼較長，應盡量選擇換行，下一行代碼應縮進 8 個空格。這樣可以使代碼排版整齊，減輕閱讀代碼的疲勞感。換行縮進 8 個空格可以和代碼段的縮進 4 個空格區分開，以增強代碼的可閱讀性。
行結束
JavaScript 語句應該以分號結束。但大多數瀏覽器允許不寫分號，只要在本應是分號的地方有一個換行符就行。但是如果代碼行較長需要換行的時候，有哪些注意事項呢？換行應選擇在操作符和標點符號之后，最好是在逗號','之后，而不要在變量名、字符串、數字、或')' ']' '++' '--'等符號之后換行。
這樣可以有效的防止拷貝、粘貼而引起的錯誤，并可有效地增強代碼的可閱讀性。請見清單1，代碼的輸出符合我們的期望。但就寫法而言，對 valueB 的賦值語句是在變量 valueA 之后進行的換行，這很容易被誤解為 valueB=ValueA，給閱讀造成障礙。而對 valueC 的復制語句是在'+'之后進行的換行，就容易理解的多。這也是本文所提倡的換行方式。
清單 1. 行結束的位置
代碼:
<script language="Javascript">
var valueA = 1;
var valueB = valueA ///bad
+1;
var valueC = valueB + ///good
valueA;
alert (valueB); //output: valueB=2
alert (valueC); //output: valueC=3
</script>
it知識庫：淺談JavaScript編程語言的編碼規范，轉載需保留來源！
鄭重聲明：本文版權歸原作者所有，轉載文章僅為傳播更多信息之目的，如作者信息標記有誤，請第一時間聯系我們修改或刪除，多謝。
