JAVA: Konvensi Penamaan di Java
Seorang programmer dikatakan menulis clean code, pada saat penamaan harus baik supaya programmer lain dapat dengan mudah membaca code/program yang dibuat. Pada tingkat rendah, tampaknya ini tidak ada artinya tapi jika kita lihat pada tingkat industri dimana perlu menulis clean code untuk menghemat waktu di mana ada aturan tertentu yang ditetapkan yang salah satu faktornya adalah memberi nama keyword yang tepat yang disebut sebagai konvensi penamaan di Java.
Misalnya ketika kita menggunakan nama variabel yang menggambarkan perpindahan maka itu harus dinamai sebagai "displace" atau serupa juga tidak mungkin x, d yang menjadi kompleks ketika code berkembang dan mengurangi keterbacaan dari code tersebut. Perhatikan ilustrasi di bawah ini untuk mendapatkan pemahaman yang lebih baik yang nanti akan kita bahas secara rinci.
Ilustrasi:
- Class: Jika kita menamai Class apa pun maka itu harus berupa kata benda dan karenanya harus dinamai sesuai tujuan yang ingin dicapai dalam program seperti Add2Numbers, ReverseString, dan sebagainya dan tidak mungkin A1, Pemrograman, dll. Itu harus secara spesifik menunjuk apa tepatnya ada di dalam tanpa melirik isi / body Class.
- Interface: Jika kita menamai interface, itu akan terlihat seperti kata sifat seperti pertimbangkan yang sudah ada: Runnable, Serializable, dll. Coba gunakan 'able' di akhir, ya dikatakan mencoba karena tidak ada ikatan aturan yang kuat dan rigid bayangkan jika kita menggunakan interface inbuilt seperti 'Remote', yang jelas-jelas tidak memiliki ble di akhirnya. Pertimbangkan jika kita seharusnya membuat interface untuk melakukan operasi baca maka disarankan sesuai konvensi penamaan di java untuk memberi nama interface 'Readable' atau yang serupa.
- Methods: Jika kita perhatikan lebih dekat dari suatu method maka seharusnya melakukan sesuatu yang terkandung di dalam tubuhnya oleh karena itu harus menggunakan kata kerja.
- Constants: Pada saat membaca namanya harus memperlihatkan bahwa nilai tersebut adalah fix / tetap, misalnya misalnya PI, MAX_INT, MIN_INT, dll.
Konvensi Penamaan di Java
Di java, adalah praktik yang baik untuk memberi nama Class, Variable, dan nama method sebagai apa yang seharusnya mereka lakukan daripada menamainya secara acak. Di bawah ini adalah beberapa konvensi penamaan bahasa pemrograman java. Mereka harus diikuti saat mengembangkan perangkat lunak di java untuk pemeliharaan dan keterbacaan code yang baik. Java menggunakan CamelCase sebagai praktik untuk menulis nama method, Variable, Class, Package, dan Constant.
Camel's Case dalam pemrograman java terdiri dari kata atau frasa majemuk sedemikian rupa sehingga setiap kata atau singkatan dimulai dengan huruf kapital atau kata pertama dengan huruf kecil, sisanya semua dengan kapital. Di sini dalam istilah yang lebih sederhana, itu berarti jika ada dua.
Catatan: Perhatikan kasus-kasus exception ini untuk camel casing di java sebagai berikut:
- Di package, semuanya huruf kecil bahkan saat kita menggabungkan dua kata atau lebih di java
- Di constant, kita menggunakan huruf besar semuanya dan karakter '_' yang digunakan jika ingin menggabungkan dua kata atau lebih di java.
Type 1: Class dan Interface
Nama Class harus berupa kata benda, dalam kasus campuran dengan huruf pertama setiap kata menggunakan huruf besar. Nama Interface juga harus dikapitalisasi seperti nama Class. Gunakan seluruh kata dan hindari akronim dan singkatan.
Class: class Student { }
class S=Integer {}
class Scanner {}
Interface : Runnable
Remote
Seriazable
Type 2: Method
Methods should be verbs, in mixed case with the first letter lowercase and with the first letter of each internal word capitalized.
public static void main(String [] args) {}
As the name suggests the method is supposed to be primarily method which indeed it is as main() method in java is the method from where the program begins its execution.
Type 3: Variable
Variable names should be short yet meaningful.
Variable names should not start with underscore _ or dollar sign $ characters, even though both are allowed. Should be mnemonic i.e, designed to indicate to the casual observer the intent of its use. One-character variable names should be avoided except for temporary variables. Common names for temporary variables are i, j, k, m, and n for integers; c, d, and e for characters.
int[] marks; double double answer,
As the name suggests one stands for marks while the other for an answer be it of any e do not mind.
Type 4: Constant variable
Should be all uppercase with words separated by underscores (“_”). There are various constants used in predefined classes like Float, Long, String etc.
num = PI;
Type 5: Package
The prefix of a unique package name is always written in all-lowercase ASCII letters and should be one of the top-level domain names, like com, edu, gov, mil, net, org. Subsequent components of the package name vary according to an organization’s own internal naming conventions.
java.util.Scanner ; java.io.*;
As the name suggests in the first case we are trying to access the Scanner class from the java.util package and in other all classes(* standing for all) input-output classes making it so easy for another programmer to identify.
Note:
For class and interfaces, the first letter has to be uppercase. For method , variable, package_name, and constants, the first letter has to be lowercase.