Camel Case 명명 및 JS에 대한 질문과 답변

이번에는 JS에서 카멜케이스 네이밍 사용법과 사용 전 주의사항에 대해 설명드리겠습니다.

카멜 케이스 이름 사용 전 주의사항: 1. Java객체 지향프로그래밍의 특성상 이름 지정 시 명사를 선택해야 합니다.

변수 이름이나 함수 이름이 하나 이상의 단어로 연결될 때, 그리고 고유 식별 단어를 구성할 때 단어의 첫 글자는 소문자로 시작하고 각 단어의 첫 글자는 대문자로 표시됩니다(첫 번째 단어 제외).

예: myFirstName

1 패키지 이름 작성 사양(Package) 패키지 이름의 고유성을 보장하기 위해 회사 또는 조직의 최상위 도메인 이름을 사용하는 것이 좋습니다. 각 기업/기관 내에서 사용되는 명칭입니다. 패키지 이름은 모두 소문자이며 실질적으로 구별되는 의미를 갖습니다.

1.1 일반 요구사항 1. 카테고리의 목적을 빠르게 전달할 수 있는 의미 있는 이름을 선택하세요.

2. 모든 패키지 이름은 영문 소문자를 사용해야 합니다.

1.2 실용적인 애플리케이션 계층화는 Dao 계층(데이터베이스 액세스), 서비스 계층(비즈니스 처리), 웹 계층(페이지 제어 작업 클래스)을 포함한 애플리케이션 시스템에서 자주 사용됩니다.

1. 패키지 이름 중 처음 몇 개는 고정된 이름입니다. 웹사이트의 경우 도메인 이름이 정해져 있지 않은 경우 회사에서 정한 이름을 사용합니다. . 예: net.vschool

2. 패키지 이름의 다음 단어는 모듈 이름입니다. 예: 사용자 모듈, 패키지 이름은 net.vschool.user

3. 모듈의 액세스 작업은 계층적 형식을 채택하며 일반적으로 다음과 같이 나뉩니다.

Dao 레이어 작업: 일반적으로 net.vschool에 정의됩니다. .xxx.dao, 여기서 xxx는 모듈 이름입니다.

서비스 계층 작업: 일반적으로 net.vschool.xxx.servie에 정의됩니다.

웹 계층 작업: 일반적으로 net.vschool.xxx.action에 정의됩니다.

다음은 사용자 모듈의 예입니다.

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

2차 클래스 이름 작성 사양(클래스) 클래스 이름은 명사를 사용해야 합니다. 클래스 이름에 여러 단어가 포함된 경우 각 단어의 첫 글자를 대문자로 사용해야 합니다. 그리고 그 뒤의 글자는 소문자로 써야 한다. 기복이 혹 모양이어서 혹 모양이라 부른다. 클래스 이름은 정확하고 간결하며 이해하기 쉬워야 합니다. 완전한 단어를 사용하고 약어 사용을 피하세요(일반적으로 인식되는 단어 제외)

2.1 클래스 이름 지정 2.1.1 일반 요구 사항 1. 클래스의 목적을 빠르게 전달할 수 있는 의미 있는 이름을 선택합니다.

2. 자바 카멜 케이스 명명 방법을 참고하면 클래스 이름의 첫 글자는 대문자여야 합니다. 클래스 이름이 여러 단어의 조합인 경우 각 단어의 첫 글자는 대문자여야 합니다. 예: StudentAnswer.java

3. 인터페이스 클래스와 구현 클래스를 구분하려면 클래스 뒤에 "Impl"을 추가하면 됩니다.

예: 인터페이스 클래스: UserInterface.java 인터페이스 구현 클래스: UserInterfaceImp

4 엔터티 클래스에는 접미사 이름이 없는 것이 좋습니다.

2.1.2 레이어링은 실제 응용 시스템에서 자주 사용되는데 Dao 레이어(데이터베이스 접근), 서비스 레이어(비즈니스 처리), 웹 레이어(페이지 제어 액션 클래스), 각 레이어의 클래스 이름은 최대한 해당 레이어 접미사.

1. Dao 레이어

a, 인터페이스 클래스: JavaBean+인터페이스+Dao, 즉 엔터티 객체+인터페이스+Dao 형식으로 정의됩니다.

예: 사용자 객체 인터페이스클래스: UserInterfaceDao, 여기서 xxx는 모듈 이름입니다.

b. 구현 클래스: JavaBean+Interface+Impl+Dao, 즉 엔터티 객체

+Interface+Impl+Dao 형식으로 정의됩니다. 예: 사용자 객체 구현 클래스: UserInterfaceImplDao

2, 서비스 레이어

a, 인터페이스 클래스: Xxx+Interface+Service, 즉 모듈+인터페이스+서비스 형식으로 정의됩니다.​

예: User Management인터페이스 클래스: UserMsgInterfaceServiec

b, 구현 클래스: Xxx+Interface+Impl+Service, 즉 module+Interface+

Impl+Service 형식으로 정의됩니다. 예: 사용자 관리 구현 클래스: UserMsgInterfaceImplServiec

3. 웹 계층(액션 클래스)

a 구현 클래스: Xxx+Operator+Action, 즉 모듈+작업+Action 형식으로 정의됩니다. 예를 들어

사용자 모듈 사용자+삭제 작업 삭제+작업 = UserDeleteAction

2.1 변수 이름 지정 2.2.1 일반 변수 2.2.2.1 일반 요구 사항 1. 변수의 목적을 빠르게 전달할 수 있는 의미 있는 이름을 선택합니다.

2. Java Camel Case 명명법을 참조하세요. 첫 글자는 소문자로 시작하고, 각 단어의 첫 글자는 대문자로 표시됩니다(첫 번째 단어 제외).

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引擎运行时是什么样的

JS的使用过程中如何自定义console对象

H5中的弹窗无法用webview弹出怎么解决

위 내용은 Camel Case 명명 및 JS에 대한 질문과 답변의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!