Difference between revisions of "JAVA: Konvensi Penamaan di Java"

From OnnoWiki
Jump to navigation Jump to search
Line 1: Line 1:
 
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.
 
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.
  
For example when you are using a variable name depicting displacement then it should be named as “displace” or similar likewise not likely x, d which becomes complex as the code widens up and decreases the readability aperture. Consider the below illustrations to get a better understanding which later on we will be discussing in detail.
 
  
Illustrations:
 
  
Class: If you are naming any class then it should be a noun and so should be named as per the goal to be achieved in the program such as Add2Numbers, ReverseString, and so on not likely A1, Programming, etc. It should be specific pointing what exactly is there inside without glancing at the body of the class.
+
==Naming Conventions in Java==
Interface: If you are naming an interface, it should look like an adjective such as consider the existing ones: Runnable, Serializable, etc. Try to use ‘able’ at the end, yes it is said to try as there are no hard and fast bound rules as if we do consider an inbuilt interface such as ‘Remote’, it is not having ble at the end. Consider if you are supposed to create an interface to make read operation then it is suggested as per naming conventions in java to name a similar likely ‘Readable’ interface.
+
 
Methods: Now if we do look closer a method is supposed to do something that it does contains in its body henceforth it should be a verb.
 
Constants: As the name suggests it should look like as we read it looks like it is fixed for examples PI, MAX_INT, MIN_INT, etc as follows.
 
Naming Conventions in Java  
 
 
In java, it is good practice to name class, variables, and methods name as what they are actually supposed to do instead of naming them randomly. Below are some naming conventions of the java programming language. They must be followed while developing software in java for good maintenance and readability of code. Java uses CamelCase as a practice for writing names of methods, variables, classes, packages, and constants.  
 
In java, it is good practice to name class, variables, and methods name as what they are actually supposed to do instead of naming them randomly. Below are some naming conventions of the java programming language. They must be followed while developing software in java for good maintenance and readability of code. Java uses CamelCase as a practice for writing names of methods, variables, classes, packages, and constants.  
  

Revision as of 16:14, 30 April 2022

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.


Naming Conventions in Java

In java, it is good practice to name class, variables, and methods name as what they are actually supposed to do instead of naming them randomly. Below are some naming conventions of the java programming language. They must be followed while developing software in java for good maintenance and readability of code. Java uses CamelCase as a practice for writing names of methods, variables, classes, packages, and constants.

Camel’s case in java programming consists of compound words or phrases such that each word or abbreviation begins with a capital letter or first word with a lowercase letter, rest all with capital. Here in simpler terms, it means if there are two

Note: Do look out for these exceptioj cases to camel casing in java as follows:

In package, everything is small even while we are combining two or more words in java In constants, we do use everything as uppercase and only ‘_’ character is used even if we are combining two or more words in java. Type 1: Classes and Interfaces

Class names should be nouns, in mixed cases with the first letter of each internal word capitalized. Interfaces names should also be capitalized just like class names. Use whole words and must avoid acronyms and abbreviations.

Classes: class Student { }
         class S=Integer {}
         class Scanner {}
Interfaces : Runnable
             Remote
             Seriazable 

Type 2: Methods

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: Variables

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 variables

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: Packages

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.


Referensi