Heim > Artikel > Web-Frontend > Fragen und Antworten zur Kamelfallbenennung und JS
Dieses Mal erkläre ich Ihnen die Benennung von Kamelfällen und die Verwendung der Namensgebung von Kamelfällen in JS sowie Vorsichtsmaßnahmen vor der Verwendung. Schauen wir uns die detaillierte Einführung unten an.
Dinge, die Sie vor der Verwendung der Kamel-Kasten-Benennung beachten sollten: 1. Aufgrund der Eigenschaften der objektorientierten Java-Programmierung sollten Sie bei der Benennung versuchen, Substantive
als zu wählen Variablennamen oder Funktionsnamen Wenn ein oder mehrere einzelne Wörter zu einem eindeutigen Identifizierungswort verbunden werden, beginnt der erste Buchstabe mit Kleinbuchstaben und der erste Buchstabe jedes Wortes wird groß geschrieben (mit Ausnahme des ersten Wortes).
Zum Beispiel: myFirstName
Schreibspezifikation für einen Paketnamen (Paket) Es wird empfohlen, den Top-Level-Domainnamen des Unternehmens oder der Organisation als Präfix des Paketnamens zu verwenden Der Zweck besteht darin, sicherzustellen, dass das Paket, das innerhalb jedes Unternehmens/jeder Institution verwendet wird, die Einzigartigkeit des Namens gewährleistet. Paketnamen bestehen ausschließlich aus Kleinbuchstaben und haben praktische Unterscheidungsbedeutung.
1.1 Allgemeine Anforderungen 1. Wählen Sie einen aussagekräftigen Namen, der den Zweck des Kurses schnell vermitteln kann.
2. Alle Paketnamen müssen englische Kleinbuchstaben enthalten.
1.2 Praktische Anwendungsschicht wird häufig in Anwendungssystemen verwendet, einschließlich der Dao-Schicht (Datenbankzugriff), der Serviceschicht (Geschäftsverarbeitung) und der Webschicht (Aktionsklasse zur Seitensteuerung).
1. Die ersten paar Namen des Paketnamens sind feste Namen. Wenn es sich um eine Website handelt, wird der Domänenname der Website in umgekehrter Reihenfolge geschrieben des Unternehmens genutzt werden. Zum Beispiel: net.vschool
2. Das nächste Wort im Paketnamen ist der Name des Moduls. Beispiel: Benutzermodul, der Paketname lautet net.vschool.user
3. In Bezug auf den Zugriffsvorgang des Moduls nimmt es eine hierarchische Form an und ist im Allgemeinen unterteilt in:
Dao-Schicht Operation: Im Allgemeinen in net .vschool.xxx.dao definiert, wobei xxx der Modulname ist.
Service-Layer-Betrieb: allgemein in net.vschool.xxx.servie definiert.
Web-Layer-Betrieb: allgemein in net.vschool.xxx.action definiert.
Das Folgende sind Beispiele für Benutzermodule:
net.vschool.user net.vschool.user.dao net.vschool.user.action net.vschool.user.service
Schreibspezifikationen für zweite Klassennamen (Klasse) Klassennamen müssen Substantive verwenden. Wenn ein Klassenname mehrere Wörter enthält, dann ist jedes Wort das Der erste Buchstabe wird großgeschrieben, die folgenden Buchstaben werden kleingeschrieben und die Wellen haben die Form eines Buckels. Personen werden im Buckelstil benannt. Die Benennung einer Klasse muss präzise, prägnant und leicht verständlich sein. Versuchen Sie, vollständige Wörter zu verwenden und vermeiden Sie Abkürzungen (außer denen, die allgemein anerkannt sind)
2.1 Benennung von Klassen 2.1.1 Allgemeine Anforderungen 1. Wählen Sie einen aussagekräftigen Namen, der den Zweck der Klasse schnell vermitteln kann.
2. In Anlehnung an die Java-Camel-Case-Nomenklatur muss der erste Buchstabe des Klassennamens in Großbuchstaben geschrieben werden. Wenn der Klassenname eine Kombination aus mehreren Wörtern ist, muss der erste Buchstabe jedes Wortes in Großbuchstaben geschrieben werden . Beispiel: StudentAnswer.java
3. Wenn Sie zwischen Schnittstellenklassen und Implementierungsklassen unterscheiden möchten, können Sie nach der Klasse „Impl“ hinzufügen.
Zum Beispiel: Schnittstellenklasse: UserInterface.java Schnittstellenimplementierungsklasse: UserInterfaceImp
4 Es wird empfohlen, dass Entitätsklassen keinen Suffixnamen haben.
2.1.2 Layering wird häufig in tatsächlichen Anwendungsanwendungssystemen verwendet: Dao-Schicht (Datenbankzugriff), Serviceschicht (Geschäftsverarbeitung), Webschicht (Seitensteuerungsaktionsklasse), der Name der Klasse in jeder Schicht sollte so weit wie möglich sein Bringen Sie dieses Layer-Suffix mit.
1. Dao-Schicht
a. Schnittstellenklasse: definiert in der Form JavaBean+Interface+Dao, also Entitätsobjekt+Interface+Dao.
Zum Beispiel: Benutzer Objektschnittstelle Klasse: UserInterfaceDao, wobei xxx der Modulname ist.
b. Implementierungsklasse: definiert in der Form JavaBean+Interface+Impl+Dao, also Entitätsobjekt
+Interface+Impl+Dao. Beispiel: Benutzerobjekt-Implementierungsklasse: UserInterfaceImplDao
2. Serviceschicht
a.
Zum Beispiel: BenutzerverwaltungSchnittstellenklasse: UserMsgInterfaceServiec
b. Implementierungsklasse: definiert in der Form Xxx+Interface+Impl+Service, also Modul+ Schnittstelle+
Impl+Service. Beispiel: Benutzerverwaltungs-Implementierungsklasse: UserMsgInterfaceImplServiec
3. Webschicht (Aktionsklasse)
a. Implementierungsklasse: definiert in der Form Xxx+Operator+Action, also Modul + Operation + Aktion. Beispiel:
Benutzermodul Benutzer+Löschaktion Löschen+Aktion = UserDeleteAction
2.1 Benennung von Variablen 2.2.1 Gewöhnliche Variablen 2.2.2.1 Allgemeine Anforderungen 1. Wählen Sie einen aussagekräftigen Namen, der schnell vermittelt werden kann Der Zweck der Variablen.
2. Beziehen Sie sich auf die Java-Camel-Fall-Nomenklatur, der erste Buchstabe beginnt mit Kleinbuchstaben und der erste Buchstabe jedes Wortes wird großgeschrieben (außer dem ersten Wort).
2.2.2.2 Praktische Anwendung 1. Die Grundstruktur der Variablenbenennung ist typeVariableName, und ein dreistelliges Präfix wird verwendet, um den Datentyp darzustellen.
Definieren Sie beispielsweise eine ganzzahlige Variable: intDocCount, wobei int den Datentyp angibt, gefolgt vom ideografischen englischen Namen, wobei der erste Buchstabe jedes Wortes groß geschrieben wird.
2. Fähigkeiten zur Verwendung von Variablen:
a. Verwenden Sie nicht dieselbe Variable in einer Funktion, um zwei Werte mit unterschiedlichen Bedeutungen darzustellen.
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中文网其它相关文章!
相关阅读:
Das obige ist der detaillierte Inhalt vonFragen und Antworten zur Kamelfallbenennung und JS. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!