Kirish
Sharhlar - bu oddiyroq bo'lishi mumkindek tuyuladi va nima uchun butun maqola yozish kerak. Lekin bu unchalik oddiy emas. Rahbarim aytganidek, har kim kod yozishi mumkin, lekin yaxshi sharh yozish qiyin. Ko'pgina til kurslari an'anaviy Hello World bilan boshlanadi. Hatto Oracle Tutorials- ning "Ishga tushirish" bo'limida biz "Salom dunyo!" Ilova . Va kodning birinchi qatorlaridan biz ularni ko'ramiz - Java sharhlari. Ularning ahamiyati Java kodlari konventsiyasi kabi muhim hujjatda sharhlarga alohida bo'lim berilganligi bilan ham ta'kidlanadi: Sharhlar . Hujjatlarga ko'ra, Java-da sharhlar ikki turga bo'linadi:- amalga oshirish sharhi (yoki kod sharhi);
- izohni hujjatlashtirish.
Java kodi sharhlari
Nomidan ko'rinib turibdiki, bu sharh kodga tegishli va uning xususiyatlarini aks ettirishi kerak. Kod sharhlari:-
Kichik harf (ya'ni, bitta qatorda tasvirlangan)
// Строчный комментарий System.out.println("Hello, World!");
-
Blok (ya'ni, ular butun blok sifatida tasvirlangan, chunki ular bir qatorga to'g'ri kelmaydi)
/* * Блочный комментарий */ System.out.println("Hello");
Har safar fikr bildirganingizda, irg'iling va o'zingizni muvaffaqiyatsizlikka uchragandek his eting."Mutlaq haqiqat yo'qligi aniq va ba'zida sharhlar kerak. Lekin har doim variantlar mavjud va keraksiz sharhlar bilan kurashish kerak. Ushbu bobda g'ayrioddiy izohlar ham eslatib o'tilgan, TODO:
// TODO: Добавить World
System.out.println("Hello, ");
Ularning mohiyati shundaki, ular IDEda maxsus tarzda ishlov berilishi mumkin. Misol uchun, IDEA-da ular alohida yorliqda to'plangan, siz ularni ko'rishingiz mumkin:
Hujjatlar uchun sharhlar
Hujjatlarga sharhlar umumiy APIni tavsiflaydi. API - bu amaliy dasturlash interfeysi, ya'ni boshqa ishlab chiquvchilar uchun har qanday harakatlarni bajarish uchun mavjud bo'lgan sinflar va usullar. Xulosa qilib aytganda, bu sharhlar nima uchun u yoki bu sinf va paket yaratilganligini va u yoki bu usul nima qilishini tushuntirishi kerak. Agar kerak bo'lsa, sinf maydonlarini ham tasvirlashingiz mumkin. Aynan shu narsani biz JavaDoc sifatida formatlangan IDE-larimizning ko'rsatmalarida ko'ramiz. Masalan:package test;
/**
* This is a JavaDoc class comment
*/
public class JavaDocTest {
/**
* This is a JavaDoc public field comment
*/
public static final String HELLO_MESSAGE = "Hello, World!";
public static void main(String... args) {
JavaDocTest.greetings();
}
/**
* This is a JavaDoc public method comment
*/
public static void greetings() {
System.out.println(HELLO_MESSAGE);
}
}
Shundan so'ng biz paketlar katalogimiz joylashgan katalogdan quyidagi buyruqni ishga tushirishimiz mumkin: javadoc -d ./test test
Shundan so'ng biz hujjatlarni yaratish jarayonini ko'ramiz.
Xulosa
Ko'rib turganimizdek, sharhlar kabi oddiy ko'rinadigan narsa haqiqatda ancha murakkabroq bo'lib chiqadi. Shuning uchun, agar siz sharhlarga biroz vaqt ajratsangiz va ularga amal qilsangiz, kodingiz yaxshiroq bo'ladi va siz dasturchi sifatida qimmatroq bo'lasiz. #ViacheslavYana nimani o'qish kerak: |
---|
GO TO FULL VERSION