首頁 > 文章 > web前端 > 駝峰命名與JS的問題解答

駝峰命名與JS的問題解答

php中世界最好的语言原創: 2017-12-04 14:57:492405瀏覽

這次幫大家解答一下駝峰命名以及駝峰命名在JS的中的使用方法，以及使用前的注意事項，下面來看詳細介紹。

駝峰命名法使用前註意事項： 1、由於Java物件物件程式設計的特性, 命名時應盡量選擇名詞

當變數名稱或函數名是由一個或多個單字連結在一起，而構成的唯一識別字時，首字母以小寫開頭，每個單字首字母大寫（第一個單字除外）。

如：myFirstName

一包名的書寫規格（Package）推薦使用公司或機構的頂級網域名稱的前綴，目的是確保各公司/機構內所使用的包名的唯一性。包名全部為小寫字母，且具有實際的區分意義。

1.1 一般要求 1、選擇有意義的名字，能快速傳達該類別的用途。

2、所有套件的命名必須採用小寫英文字母。

1.2 實際應用應用系統中經常套用分層，Dao層（資料庫存取）、Service層（業務處理）、Web層（頁面控制action類別）。

1、包名的前幾個為固定名稱, 如果是網站的話，採用網站的網域的反寫，如果網域還沒有確定的話，採用公司固定的幾個名稱。如：net.vschool

2、在套件名稱的接下來一個單字為模組的名稱。如：使用者模組，套件名稱為net.vschool.user

3、關於模組的存取操作，採用分層形式,一般分為：

Dao層操作：一般定義在net .vschool.xxx.dao 中，其中xxx為模組名稱。

Service層操作：一般定義在net.vschool.xxx.servie中。

web層操作：一般定義在 net.vschool.xxx.action中。

如下關於使用者模組的例子：

net.vschool.user
net.vschool.user.dao
net.vschool.user.action
net.vschool.user.service

二類名的書寫規格(Class) 類別名稱必須使用名詞，如果一個類別名稱內含多個單字，那麼各個單字第一個字母大寫，後續字母小寫，起伏呈駝峰狀，人稱駝峰式命名。為類別名稱命名時，必須保證準確、簡潔且容易理解。盡量使用完整單字，避免使用縮寫詞（除了大家公認的）

2.1 類別的命名 2.1.1 一般要求 1、選擇有意義的名字，能快速地傳達該類別的用途。

2、參考java駝峰命名法，類別名稱的首字母必須採用大寫的形式，如果類別名為多字組合而成的話，那麼每個字的首字母必須採用大寫。如：StudentAnswer.java

3、要區別介面類別和實作類別的時候，可以在類別的後面加上「Impl」。

如：介面類別：UserInterface.java 介面實作類別：UserInterfaceImp

4、推薦實體類別沒有字尾名。

2.1.2 實際應用應用系統中經常應用分層，Dao層（資料庫存取）、Service層（業務處理）、Web層（頁面控制action類別），每一層的類別的名稱盡量帶上該層後綴。

1、Dao層

a、介面類別：採用JavaBean+Interface+Dao的形式來定義,即，實體物件+Interface+Dao。

如：使用者物件介面類別： UserInterfaceDao，其中xxx為模組名稱。

b、實作類別：採用JavaBean+Interface+Impl+Dao的形式來定義,即，實體物件

+Interface+Impl+Dao。如：使用者物件實作類別：UserInterfaceImplDao

2、Service層

a、介面類別：採用Xxx+Interface+Service的形式來定義,即，模組+Interface+Service。

如：使用者管理介面類別：UserMsgInterfaceServiec

b、實作類別：採用Xxx+Interface+Impl+Service的形式來定義,即，模組+Interface+

Impl+Service。如：使用者管理實作類別：UserMsgInterfaceImplServiec

3、Web層（action類別）

a、實作類別：採用縣Xxx+Operator+Action的形式來定義,即，模組+操作+Action。如

使用者模組User+刪除操作Delete+Action = UserDeleteAction

2.1 變數的命名2.2.1 普通變數2.2.2.1 一般要求1、選擇有意義的名字，能快速傳達該名字變數的用途。

2、參考java駝峰命名法，首字母以小寫開頭，每個單字首字母大寫（第一個單字除外）。

2.2.2.2 實際應用 1、變數命名採用基本結構為typeVariableName，使用3字元前綴來表示資料類型。

例如，定義一個整形變數：intDocCount，其中int表示資料類型，後面為表意的英文名，每個單字首字母大寫。

2、變數使用技巧：

a、在一段函數中不使用同一個變數表示前後意義不同的兩個數值。

b、除非是在循环中，否则一般不推荐使用单个字母作为变量名，i、j、k等只作为小型循环的循环索引变量。

c、避免用Flag来命名状态变量。

d、用Is来命名逻辑变量，如：blnFileIsFound。通过这种给布尔变量肯定形式的命名方式，使得其它开发人员能够更为清楚的理解布尔变量所代表的意义。

e、如果需要对变量名进行缩写时，一定要注意整个代码中缩写规则的一致性。例如，如果在代码的某些区域中使用intCnt，而在另一些区域中又使用intCount，就会给代码增加不必要的复杂性。建议变量名中尽量不要出现缩写。

2.2.2 静态变量 1、选择有意义的名字，能快速地传达该变量的用途。

2、参照java驼峰命名法，采用全部大写的形式来书写，对于采用多词合成的变量采用“_”来连接各单词。如：USER_LIST

2.3 方法的命名 2.3.1 一般要求 1、选择有意义的名字，能快速地传达该方法的用途。

2、参照java驼峰命名法，首字母以小写开头，每个单词首字母大写（第一个单词除外）。

2.3.2 实际应用 1、方法表示一种行为，它代表一种动作，最好是一个动词或者动词词组或者第一个单词为一个动词。

2、属性方法：以get/set开头，其后跟字段名称，字段名称首字母大写。如：getUserName()

3、数据层方法：只能以insert（插入）,delete（删除）,update（更新）,select（查找）,count（统计）开头，其他层方法避免以这个5个单词开头，以免造成误解。

4、服务层方法，根据方法的行为命名，只描述方法的意义，而不采用方法的目的命名。比如系统的添加新用户，用户可以前台注册，也可以管理员后台添加，方法会被重用，所以最好不要用使用register，采用add会更好写。避免使用与web层相关的方法。

5、Web层方法最好是贴近web的语言，如register，login，logout等方法。

三注释的书写规范（Javadoc） Java除了可以采用我们常见的注释方式（//、/* */）之外，Java语言规范还定义了一种特殊的注释，也就是我们所说的Javadoc注释，以/**开头，而以*/结束， Javadoc 注释可以被自动转为在线文档，省去了单独编写程序文档的麻烦。推荐使用。

Javadoc注释主要涉及范围：类、属性、方法。

例如：

复制代码代码如下:

package org.ietf.jgss;
import java.net.InetAddress;
import java.util.Arrays;
/**
 * 该类的整体性描述。
 *
 * @author 作者
 * @version 1.0, 05/22/07
 * @since 1.0
 */
public class ChannelBinding {
/**
 * 对该变量的备注信息
 */
private InetAddress initiator;
/**
 * 对该变量的备注信息
 */
private InetAddress acceptor;
/**
 * 对该变量的备注信息
 */
    private  byte[] appData;
    /**
     * 对该类的构造函数的备注信息。
     *
     * @param initAddr 对参数的备注。
     * @param acceptAddr对参数的备注。
     * @param appData对参数的备注。
     */
    public ChannelBinding(InetAddress initAddr, InetAddress acceptAddr,
              byte[] appData) {
         initiator = initAddr;
         acceptor = acceptAddr;
         if (appData != null) {
              this.appData = new byte[appData.length];
              java.lang.System.arraycopy(appData, 0, this.appData, 0,
                   appData.length);
         }
    }
    /**
     * 对该类的具体一函数的备注信息
     *
     * @param obj 参数的备注信息
     * @return 返回值的备注信息
     */
    public boolean equals(Object obj) {
         if (this == obj)
              return true;
         if (! (obj instanceof ChannelBinding))
              return false;
         ChannelBinding cb = (ChannelBinding) obj;
         return Arrays.equals(appData, cb.appData);
    }
}

四其他书写规范

4.1 Jsp页面名称的书写规范 1．全部采用小写的英文字符和”_ ”组成。

2．整体采用模块名+操作的形式。如：user_view.jsp

3．Jsp页面尽可能与action的意思对应，如UserListAction 对应者user_list.jsp

相信看了这些案例你已经掌握了方法，更多精彩请关注php中文网其它相关文章！

駝峰命名與JS的問題解答

相關文章