Scribd Logo
Hochladen

Willkommen bei Scribd!

  • Cómo Documentar Nuestro Código!!! - Java en General

    Hochgeladen von

    Ben Avraham
    110 Ansichten4 Seiten
    tip

    Originaltitel

    Cómo Documentar Nuestro Código!!! _ Java en General

    Copyright

    © © All Rights Reserved

    Verfügbare Formate

    PDF, TXT oder online auf Scribd lesen

    Stufen Sie dieses Dokument als nützlich ein?

    Sind diese Inhalte unangemessen?

    Dieses Dokument melden
    tip

    Copyright:

    © All Rights Reserved
    Als PDF, TXT herunterladen oder online auf Scribd lesen
    Markieren Sie unangemessene Inhalte
    110 Ansichten4 Seiten

    Cómo Documentar Nuestro Código!!! - Java en General

    Hochgeladen von

    Ben Avraham
    tip

    Copyright:

    © All Rights Reserved
    Als PDF, TXT herunterladen oder online auf Scribd lesen
    Markieren Sie unangemessene Inhalte
    von 4

    28/4/2015

    INICIO

    Cmodocumentarnuestrocdigo!!!|JavaenGeneral

    ACERCA

    CONTACTO

    Cmo documentar nuestro cdigo!!!

    Search

    junio26,2014 java Tagged:documentacin,documentacinjava,java,javadoc 3comments

    Ladocumentacindecdigoesunadelasbuenasprcticasarealizaralmomentodeprogramar,sobretodo
    cuando se trata de Proyectos de Desarrollo de Software, cuando se ve involucrado un grupo de trabajo
    dondesegeneracdigopordiferentespersonasysedeseatenerclaridadalmomentodeutilizaroreutilizar
    componentes ya programados. La documentacin representa una ventana en estas situaciones donde el
    tiempo es factor clave al momento de entender qu hace y representan estos componentes que poseen

    Categoras
    Glassfish
    java

    mtodos,clases,atributosyquesedebedetenerentendimientodesufuncionalidad.
    JavaSwing
    Por ejemplo en la siguientes imgenes se aprecia la funcionalidad de la documentacin al momento de
    programaryentendersuuso:

    JEE
    JPA
    Jtable
    Libros
    ManualdeJava
    Sincategora
    TableModel

    BscanosenFacebook

    JavaenGeneral
    Megusta Tegustaesto.

    Atiy612personasmslesgustaJavaenGeneral.

    PluginsocialdeFacebook

    Como se puede apreciar al resaltar la clase Integer se desglosa su respectiva documentacin y lo mismo
    con su mtodo ParseInt(), esto nos facilita el entendimiento de la clase y su mtodo, para qu sirven y

    Ingresesuemail:

    cmo se usan, incluso nos muestra que puede generar una Excepcin del tipo NumberFormatException
    ynospermitepreverquepuedeocurrirunaexcepcinyusarunTryCatch.
    Generar mi propia Documentacin
    Como vimos es bastante importante y una buena prctica documentar lo que programemos, para que as

    Subscribirse

    otraspersonasyhastanosotrosmismotengamosmayorentendimientodenuestroprograma.
    Para documentar cualquier lnea de cdigo se usa lo mismo que para realizar comentarios multilnea pero
    conunasteriscoms.Estoes:

    Java en General
    Siguiendo a

    +1

    PorejemploparadocumentarunaClasecreadapornosotros,seraalgoas..

    http://www.javaengeneral.com/comodocumentarnuestrocodigo/

    1/4

    28/4/2015

    Cmodocumentarnuestrocdigo!!!|JavaenGeneral

    EnestecasosedocumentloreferentealaclasedenombrePrincipal.Sepuedenusaretiquetaspropias
    de java como @author, @version, @see,etc. para representar datos representativos y etiquetas html para
    adecuarelcontenidodeladescripcindelaclase.
    Acunejemplo:

    http://www.javaengeneral.com/comodocumentarnuestrocodigo/

    2/4

    28/4/2015

    Cmodocumentarnuestrocdigo!!!|JavaenGeneral

    Con estos damos por terminada la forma de documentar nuestro cdigo, en la siguiente entrada veremos
    comogenerarnuestradocumentacinaunarchivo<html>paraqueseavistodemaneraexterna.
    Compartir

    56

    Megusta

    56

    Twittear

    3 thoughts on Cmo documentar nuestro cdigo!!!


    Amcrak
    26junio,2014at1:48pm
    Buenainfocompaero,sondemuchaayuda
    Reply

    Santiago
    27junio,2014at7:24pm
    Muybueno!!!
    Reply

    Ferran
    29junio,2014at8:22pm
    Muybueno,gracias!
    Reply

    Deja un comentario
    Tudireccindecorreoelectrniconoserpublicada.Loscamposnecesariosestnmarcados*

    Name*

    http://www.javaengeneral.com/comodocumentarnuestrocodigo/

    3/4

    28/4/2015

    Cmodocumentarnuestrocdigo!!!|JavaenGeneral
    Email*
    Website

    Publicarcomentario

    Comentarios recientes
    JTableUsandoel
    TableModel|JavaenGeneral
    enJTableObtenerdatos
    JTableUsandoel
    TableModel|JavaenGeneral
    enJTableDistribucinde
    datos:TableModel
    JTableDistribucindedatos:
    TableModel|JavaenGeneral
    enJTableUsandoel
    TableModel
    JuanA.enLayoutenJava
    SwingGridLayout
    BorderLayoutFlowLayout
    JavaenGeneralenQues
    JPA?

    JavaenGeneralPoweredbyWordPress

    http://www.javaengeneral.com/comodocumentarnuestrocodigo/

    MaxMagazineThemewascreatedby

    4/4

    Das könnte Ihnen auch gefallen