| Hjem | Hardware | Netværk | Programmering | software | Fejlfinding | systemer | 
Programmering  
  • C /C + + Programming
  • Computer Programmeringssprog
  • Delphi programmering
  • Java programmering
  • JavaScript Programmering
  • PHP /MySQL programmering
  • Perl programmering
  • Python Programming
  • Ruby Programming
  • Visual Basics Programmering
  •  
    Computer Viden >> Programmering >> Java programmering >> Content
    Sådan oprettes javadoc når kommentere
    javadoc er de facto standard for generering af dokumentation fra kildekode. Det er et redskab til at skabe HTML dokumentation fra specielt formaterede kommentarer i Java-kode . Dette kan bruges til at generere struktureret application programming interface ( API) dokumentation automatisk , give nogle hints til IDE eller tildeling af pakker , klasser og metoder. Væsentlige, det er en måde at kommentere parameterbeskrivelser , der skrev hvad, og hvem der bærer skylden , hvis det går i stykker. Java kommer med javadoc kommando -line program til at generere HTML dokumentation , men de fleste Java- integrerede udviklingsmiljøer ( IDE'er ) har også denne integreret. Instruktioner
    1

    Opret specielle javadoc kommentarer . At betegne en javadoc kommentar , skal du starte kommentaren med /** . Javadoc kommentarer normalt findes på toppen af ​​en fil , før klasser og før metoder . Da det er udviklet til fuld API-dokumentation , er det ikke ualmindeligt at se filer med flere javadoc kommentarer end kode. "" /*** Dette er en javadoc kommentar . Det har ikke nogen javadoc meta-tags endnu, men det gjorde udløse javadoc parser til at tage et kig på denne kommentar. * /""
    2

    Tilføj API meta- tags (tags , der beskriver API selv) , når kommentere . API tags er parameter , beskrivelser, undtagelse profiler, returværdi beskrivelser, metode navne og metode beskrivelser. Mange IDE'er indarbejde disse data i deres værktøjstip og andre hjælpere , samt at det er til brug i HTML eller kommentar form .
    3

    Brug metodebeskrivelsen . Denne meta- tag har ingen tags navn : Det er simpelthen den kommentar , der kommer før de andre tags "" /*** Beregner hældningen af en linje. . * /""
    4

    Indarbejd parameterbeskrivelser . Disse er angivet med @ param meta-tags , som bør følges op af en parameter navn og beskrivelse . "" /*** Beregner hældningen af en linje. ** @ Param p1 Første punkt , der beskriver linjen * @ param p2 Andet punkt , der beskriver linjen * /""
    5

    returværdi beskrivelser . Dette betegnes med @ return meta- tag og bør følges af en beskrivelse af returværdien. "" /*** Beregner hældningen af en linje. ** @ Param p1 Første punkt , der beskriver linjen * @ param p2 Andet punkt , der beskriver linjen * @ return hældning som float * /""
    6

    Tilføj attribution tags. Mærkerne tilskriver koden til en bestemt forfatter . "" /*** Beregner hældningen af en linje. ** @ Forfatter Jack Smith * @ param p1 Første punkt , der beskriver linjen * @ param p2 Andet punkt , der beskriver linjen * @ return hældning som float * /""
    7

    Generer HTML dokumentation. Hvis du ikke bruger en IDE eller du blot ønsker at gøre det manuelt , kan du køre javadoc kommando-line program fra dit projekt bibliotek. Angiv output mappe med - d switch og videregive det en liste over . Java-filer (normalt som et wildcard ) . "" Javadoc - d docs * . Java ""
    < br >

    Forrige :

    næste :
      Relaterede artikler
    ·Abstrakt klasse Vs. Grænseflade i Java 
    ·Sådan bruges Slå Java 
    ·Hvordan man undgår at hardcoding i Eclipse Projekter 
    ·Tutorial On JMS 
    ·Java Spring Vs . Struts 
    ·Sådan får du en valgt alternativknap i en Servlet Fra…
    ·Sådan Load variable fra JSP /Java -filer til Flash 
    ·Sådan Tag et skærmbillede Brug Java 
    ·Sådan bruges Java Web Start 
    ·Hvordan søger jeg en fil oprettet Brug Java Servlet 
      Anbefalede Artikler
    ·Java og Random funktioner 
    ·Sådan Opret din egen Study Instans UID 
    ·Sådan Rediger Time i Registry Med en batch-fil 
    ·Hvordan at begrænse input værdier på Breve Kun i VB.…
    ·ASP.NET Projekter og Kodning i C 
    ·Sådan installeres PyGame Med Python 2.7 på en Mac 
    ·Sådan oprettes en Medarbejder Log ind Visual Basic 
    ·Hvordan man skriver til en CSV-fil med PHP 
    ·Hvordan man lærer C + + 
    ·Definition af begivenheder i Visual Basic 
    Copyright © Computer Viden http://www.computerdk.com