Java-daky teswirler: hemme zat beýle bir ýönekeý däl

Giriş

Düşündirişler - has ýönekeý bolup görünýär we näme üçin tutuş bir makala ýazmaly. Emma bu ýönekeý däl. Başlygymyň aýdyşy ýaly, her kim kod ýazyp biler, ýöne gowy teswir ýazmak kyn. Dil kurslarynyň köpüsi adaty “Salam dünýä” bilen başlaýar. Hatda Oracle Tutorials-da, "Başlamak" bölüminde "Salam Dünýä!" Bilen başlaýarys. Arza . Kodyň ilkinji setirlerinden olary görýäris - Java teswirleri. Olaryň ähmiýeti , Java kod konwensiýasy ýaly möhüm resminamada düşündirişlere aýratyn bölüm berilýändigi bilen düşündirilýär . Resminamalara görä, Java-daky teswirler iki görnüşe bölünýär:

• ýerine ýetiriş düşündirişi (ýa-da kod düşündirişi);
• resminama düşündiriş.

Kod düşündirişleri aýratyn setirleri / bloklary suratlandyrmak üçin ulanylýar we resminama düşündirişleri koduň (interfeýsiniň) ýerine ýetirilişine bagly bolmadyk spesifikasiýasyny beýan etmek üçin ulanylýar. Java teswirleri düzüji tarapyndan hasaba alynmaýar ulanyjy däl-de, dörediji üçin manyly. Şonuň üçin düzülen synplaryň göwrümini azaldyp bilersiňiz.

Java kod düşündirişleri

Adyndan bu teswiriň koda degişlidigi we aýratynlyklaryny görkezmelidigi düşnüklidir. Kod düşündirişleri:

• Baş harp (meselem, bir setirde düşündirilýär)

  // Строчный комментарий
  System.out.println("Hello, World!");




• Blok (meselem, bir setirde gabat gelmeýändigi sebäpli tutuş blok hökmünde suratlandyrylýar)

  /*
   * Блочный комментарий
   */
  System.out.println("Hello");

Blok düşündirişiniň gyzykly aýratynlygy, eger ony “ / * - ” (ýagny ýyldyz ýyldyzyndan soň minus belgisini goşmak) bilen başlasak, bu blok teswiriniň teksti formatlanmaz. Gyzykly, ýöne käbir teswirleriň kömegi bilen käbir IDE görkezmelerini berip bilersiňiz. Mysal üçin, Eclipse IDE-de " // @ formatter: on " we " // @ formatter: off " teswirlerini ulanyp, kod bölümleriniň formatirlemesini öçürip bilersiňiz. Teswirleri az we diňe zerur ýerlerde ulanmaly. Mysal üçin, bu mowzukda bir makalany okap bilersiňiz: "Koda teswir ýazmaň!" . Arassa kod: Robert Martin tarapyndan döredilen, derňeýän we gaýtadan işleýän atly ajaýyp kitap bar . Onda “Teswirler” atly aýratyn bölüm bar. Bu bapyň epigrafy hökmünde Brian W. Kernighan we P. J. Plower-den: “Erbet kody düşündirmäň, gaýtadan ýazyň” diýen ýaly ajaýyp sitata. Bu bapy Google Kitaplaryndan tapyp bilersiňiz . Umumy many, ondan bir sitatada beýan edilip bilner:

Her gezek teswir ýazanyňyzda, özüňizi şowsuz ýaly duýuň. "

Mutlak hakykatyň ýokdugy düşnüklidir we käwagt teswirler zerur bolýar. Emma elmydama wariantlar bar we gereksiz teswirler bilen göreşmeli. Bu bapda adaty bolmadyk teswirler, TODO hem agzalýar:

// TODO: Добавить World
System.out.println("Hello, ");

Olaryň maksady, IDE-de aýratyn usul bilen işlenip bilinmegi. Mysal üçin, IDEA-da aýratyn tabda ýygnalýar, olary görüp bilersiňiz: Teswirli kiçijik bir başagaý: “http://google.com” setiri usulyň içinde dogry setir, sebäbi http bu ýerde aslynda bellik, soň bolsa teswir. Köplenç kod teswirlerinden resminama düşündirişlerine geçip biler, bu hakda soň gürleşeris.

Resminamalar üçin düşündirişler

Resminamalaryň düşündirişleri köpçülige açyk API-ni suratlandyrýar. API programma programmirleme interfeýsi, ýagny beýleki işläp düzüjiler üçin islendik hereketi ýerine ýetirmek üçin elýeterli bolan synplar we usullar. Gysgaça aýdylanda, bu teswirler bu ýa-da beýleki synpyň we bukjanyň näme üçin döredilendigini we bu ýa-da beýleki usulyň näme edýändigini düşündirmeli. Gerek bolsa synp meýdanlaryny hem suratlandyryp bilersiňiz. JavaDoc görnüşinde formatlanan IDE-lerimiziň gural görkezijilerinde görşümiz ýaly. Mysal üçin: Bu usula girsek, bu tekstiň nireden gelendigini görüp bileris: Againene-de Java kod konwensiýasyna serediň: JavaDoc-y nädip formatlaşdyrmalydygy barada kod konwensiýasy . Teswirleri blokirlemäge birneme meňzeýär, ýöne bir ýyldyzyň ýerine (Asterix däl) ikisi ulanylýar. JavaDoc-a mysal ýokarda berildi. Allhli mümkinçilikleri suratlandyrmagyň manysy ýok, sebäbi bu eýýäm resmi Oracle resminamalarynda ýazylypdy. Şonuň üçin resmi JavaDoc resminamalarynda, "Bellikleriň beýany" bölüminde size zerur zatlaryň hemmesine seredýäris . Oracle-yň hatda bu mowzukda aýratyn bir sapagy bar: Javadoc Tool üçin resminama teswirlerini nädip ýazmaly . IDE-de gurallar gowy, ýöne bir sebäbe görä resminamalar. Bu JavaDoc düşündirişlerine esaslanyp, resminamalar döredilýär. Munuň üçin ýörite javadoc peýdasy bar . Görşümiz ýaly, şol Tutorial bu hakda gürleýär. Ony nädip ulanmalydygynyň beýany JavaDoc üçin resmi Oracle web sahypasynda . Munuň nähili bolýandygyny özüňiz görmek üçin bukjanyň ady bilen bukjada kiçi bukja döredip bilersiňiz, mysal üçin: synag . Onda teswirler bilen ýönekeý synp dörediň. Mysal üçin:

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);
  }
}

Ondan soň paket bukjamyzy öz içine alýan katalogdan aşakdaky buýrugy işledip bileris: javadoc -d ./test test Ondan soň resminamalary döretmek prosesini göreris. Soň bolsa döredilen resminamany görmek üçin index.html açyp bileris. API resminamalarynyň goýulýandygyny köplenç görersiňiz. Mysal üçin, Bahar Çarçuwaly API .

Netije

Görşümiz ýaly, teswirler ýaly ýönekeý ýaly görünýän zat hakykatda has çylşyrymly bolup çykýar. Şonuň üçin teswirlere wagt sarp edip, olary yzarlasaňyz, koduňyz has gowy bolar we programmist hökmünde has gymmatly bolarsyňyz. # Wiaçeslaw