Node.js編碼規範,node.js編碼

來源:互聯網
上載者:User

Node.js編碼規範,node.js編碼

調用函數的時候,函數名與左括弧之間沒有空格。

函數名與參數序列之間,沒有空格;所有其他文法元素與左括弧之間,都有一個空格。

使用小駝峰式命名法作為所有變數和屬性的命名規則。
縮排使用兩空格,統一使用單引號。
關聯陣列,除非鍵名中有空格或是非法字元,否則一律不用引號。
不要將不同目的的語句,合并成一行。
不要省略句末的分號,哪怕一行只有一個語句。
不要使用自增(++)和自減(--)運算子,用+=和-=代替。
不要使用"相等"(==)運算子,只使用"嚴格相等"(===)運算子。
所有變數聲明都放在函數的頭部。
所有函數都在使用之前定義。
盡量給建構函式和回呼函數命名,這樣當你在調試的時候可以看見更清晰的調用棧。
盡量將所有的成員函數通過原型定義,將屬性在建構函式內定義,然後對建構函式使用new關鍵字建立對象。
避免複雜的繼承,如果要繼承,盡量使用util模組中的inherits函數。比如A繼承B,可以util.inherits(A,B)。


參考資料:
《Node.js開發指南》附錄B(BYVoid)

Javascript編程風格(阮一峰)



文檔資訊

  • 著作權聲明:自由轉載-非商用-非衍生-保持署名 | Creative Commons BY-NC-ND 3.0
  • 原文網址:http://blog.csdn.net/cdztop/article/details/37749051
  • 最後修改時間:2014年07月14日 01:50


JAVA編碼規範

(1) 類名首字母應該大寫。欄位、方法以及對象(控制代碼)的首字母應小寫。對於所有標識符,其中包含的所有單詞都應緊靠在一起,而且大寫中間單詞的首字母。例如:
ThisIsAClassName
thisIsMethodOrFieldName
若在定義中出現了常數初始化字元,則大寫static final基本類型標識符中的所有字母。這樣便可標誌出它們屬於編譯期的常數。
Java包(Package)屬於一種特殊情況:它們全都是小寫字母,即便中間的單詞亦是如此。對於網域名稱副檔名稱,如com,org,net或者edu等,全部都應小寫(這也是Java 1.1和Java 1.2的區別之一)。
(2) 為了常規用途而建立一個類時,請採取"經典形式",並包含對下述元素的定義:
equals()
hashCode()
toString()
clone()(implement Cloneable)
implement Serializable
(3) 對於自己建立的每一個類,都考慮置入一個main(),其中包含了用於測試那個類的代碼。為使用一個項目中的類,我們沒必要刪除測試代碼。若進行了任何形式的改動,可方便地返回測試。這些代碼也可作為如何使用類的一個樣本使用。
(4) 應將方法設計成簡要的、功能性單元,用它描述和實現一個不連續的類介面部分。理想情況下,方法應簡明扼要。若長度很大,可考慮通過某種方式將其分割成較短的幾個方法。這樣做也便於類內代碼的重複使用(有些時候,方法必須非常大,但它們仍應只做同樣的一件事情)。
(5) 設計一個類時,請設身處地為客戶程式員考慮一下(類的使用方法應該是非常明確的)。然後,再設身處地為管理代碼的人考慮一下(預計有可能進行哪些形式的修改,想想用什麼方法可把它們變得更簡單)。
(6) 使類儘可能短小精悍,而且只解決一個特定的問題。下面是對類設計的一些建議:
一個複雜的開關語句:考慮採用"多形"機制
數量眾多的方法涉及到類型差別極大的操作:考慮用幾個類來分別實現
許多成員變數在特徵上有很大的差別:考慮使用幾個類
(7) 讓一切東西都儘可能地"私人"--private。可使庫的某一部分"公用化"(一個方法、類或者一個欄位等等),就永遠不能把它拿出。若強行拿出,就可能破壞其他人現有的代碼,使他們不得不重新編寫和設計。若只公布自己必須公布的,就可放心大膽地改變其他任何東西。在多線程環境中,隱私是特別重要的一個因素--只有private欄位才能在非同步使用的情況下受到保護。
(8) 謹惕"巨大對象綜合症"。對一些習慣於順序編程思維、且初涉OOP領域的新手,往往喜歡先寫一個順序執行的程式,再把它嵌入一個或兩個巨大的對象裡。根據編程原理,對象表達的應該是應用程式的概念,而非應用程式本身。
(9) 若不得已進行一些不太雅觀的編程,至少應該把那些代碼置於一個類的內部。
(10) 任何時候只要發現類與類之間結合得非常緊密,就需要考慮是否採用內部類,從而改善編碼及維護工作(參見第14章14.1.2小節的"用內部類改進代碼")。
(11) 儘可能細緻地加上注釋,並用javadoc注釋文檔文法產生自己的程式文檔。
(12) 避免使用"魔術數字",這些數字很難與代碼很好地配合。如以後需要修改它,無疑會......餘下全文>>
 
HTML編碼有什規範要?

1.HTML編碼規範
HTML並不是一種程式設計語言,而是一種標記語言,它沒有任何真正的程式設計語言中的迴圈或是流程式控制制語句。然而,HTML代碼的格式和風格是非常重要的,因為要經常對HTML代碼進行維護和修改,因此HTML代碼必須有很清晰的邏輯結構和布局,而使其易懂和易於維護。

1.1 標記的書寫
HTML語言是不區分大小寫,但一般來說,標記使用大寫書寫,如<P>, <HTML>, <TABLE>等;標記中的屬性一般使用小寫,如<A href=”a.html”>, <font size=”5”>等。

1.2 標記的換行規範

一般一個HTML代碼都會很長很複雜,因此不要把代碼寫得很密,這樣的可讀性非常差,HTML對斷行符號和空格都不敏感,因此可以使用斷行符號和空格,使代碼的格式和結構更清晰,這樣才能易於維護。很多標記一般來說要佔用一行,除了同一標記的關閉標記外,最好不出現兩個標記在同一行的情況。如:

<TABLE><TR><TD>text</TD></TR></TABLE>

應寫成:

<TABLE>

<TR>

<TD>text</TD>

</TR>

</TABLE>

1、 通常情況下,應該換行的標記有:

Ø <HTML>和</HTML>

Ø <BODY></BODY>

Ø <HEAD></HEAD>

Ø <FORM></FORM>

Ø 當段落內容比較長時,<P></P>也應各佔一行

Ø 各種列表標記

Ø 表格的相關標記

Ø <BLOCKQUOTE>和</BLOCKQUOTE>

Ø <PRE>和</PRE>

Ø <CODE>和</CODE>

2、 通常情況下,需要將開始和關閉標記放在一行的標記有:

Ø <B>和</B>

Ø <U>和</U>

Ø <I>和</I>

Ø 各種標題標記,如<H1>…</H1>等

Ø <A>和</A>

1.3 標記的關閉規範:
1、 HTML文檔的本文都應在<BODY></BODY>標記中間,而<BODY>標記則應包含在<HTML>和</HTML>標記之間,如

<HTML>

<BODY>

…………

&l......餘下全文>>
 

聯繫我們

該頁面正文內容均來源於網絡整理,並不代表阿里雲官方的觀點,該頁面所提到的產品和服務也與阿里云無關,如果該頁面內容對您造成了困擾,歡迎寫郵件給我們,收到郵件我們將在5個工作日內處理。

如果您發現本社區中有涉嫌抄襲的內容,歡迎發送郵件至: info-contact@alibabacloud.com 進行舉報並提供相關證據,工作人員會在 5 個工作天內聯絡您,一經查實,本站將立刻刪除涉嫌侵權內容。

A Free Trial That Lets You Build Big!

Start building with 50+ products and up to 12 months usage for Elastic Compute Service

  • Sales Support

    1 on 1 presale consultation

  • After-Sales Support

    24/7 Technical Support 6 Free Tickets per Quarter Faster Response

  • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.