Java бағдарламалау тіліне кіріспе. Java тілі туралы жалпы түсінік



бет3/4
Дата01.03.2023
өлшемі42,05 Kb.
#70653
түріНұсқаулар
1   2   3   4

Javadoc Пікірлер


Java API жазу үшін арнайы Javadoc түсініктемелерін пайдаланыңыз. Javadoc JDK-мен қамтылған, ол бастапқы кодтағы түсініктемелерден HTML құжаттарын жасайтын құрал болып табылады.
> .java бастапқы файлдарындағы Javadoc түсініктемесі бастапқы және аяқталу синтаксисіне келесі түрде қосылады: > / ** және > * / . Олардың ішіндегі әрбір түсініктеме > * .
Осы түсініктемелерді тікелей әдіс, сынып, конструктор немесе құжаттағыңыз келген басқа Java элементінің үстіне қойыңыз. Мысалға:
// myClass.java / ** * Бұл сыныпты сипаттайтын қысқаша сөйлем жасаңыз. * Басқа жол. * / public class myClass {...}
Javadoc құжаттаманың қалай жасалатынын басқаратын түрлі тегтерді қамтиды. Мысалы, > @param тегі параметрді параметрлерге анықтайды:
/ ** Негізгі әдіс * @param args String [] * / public static void main (String [] args) {System.out.println («Сәлем әлем!»);}
Көптеген басқа тегтер Javadoc-да қол жетімді және ол HTML-тегтерді шығаруды басқаруға көмектеседі.
Қосымша ақпарат алу үшін Java құжаттамаңызды қараңыз.

Пікірлерді пайдалану туралы кеңестер


  • Пікір қалдырыңыз. Сіздің бағдарламаңыздың әрбір жолын түсіндірудің қажеті жоқ. Егер сіздің бағдарламаңыз логикалық түрде жүрсе және күтпеген ештеңе болмаса, түсініктеме қосу қажеттілігін сезінбеңіз.

  • Пікіріңізді қиыңыз. Сіз түсіндіріп отырған код сызығының шегінісі болса, сіздің пікіріңіз шабуылға сәйкес келетініне көз жеткізіңіз.

  • Түсініктемелерді сақтаңыз. Кейбір бағдарламашылар кодты өзгерту кезінде өте жақсы, бірақ кейбір себептермен ескертулерді жаңартуды ұмытып кетеді. Егер түсініктеме енді қолданылмаса, онда оны өзгертуге немесе жоюға болады.

  • Түсініктемелерді блоктамаңыз. Төменде компиляторлық қате пайда болады: > / * бұл - / * Бұл блок түсініктемесі бірінші түсініктемені аяқтайды * / блоктық түсініктеме * /


Достарыңызбен бөлісу:
1   2   3   4




©emirsaba.org 2024
әкімшілігінің қараңыз

    Басты бет