Er dokumentasjon relevant for arkiv?

[Ole Aamot]

Boken beskriver javadoc på side 42:

    SUN MICROSYSTEMS recommends the following Javadoc tag ordering:

    In classes and interface descriptions:

    /** 
     * Description.
     *
     * @author
     * @version
     *
     * @see
     * @since
     * @deprecated
     */

    Consider including an @author and @version tag in every class or interface description.

    List multiple @author tags in chronological order, with the class or interface creator
    listed first.

    In method descriptions:

    /**
     * Description.
     *
     * @param
     * @return
     * @exception
     *
     * @see
     * @since
     * @deprecated
     */

    Include a @param tag for every parameter.  List multiple @param tags in parameter declaration order.

    Include a @return tag if the method returns any type other than void.

    Include an @exception tag for every checked exception listed in a throws clause.
    Include an @exception tag for every unchecked exception that a user may reasonably expect to catch.
    List multiple @exception tags in alphabetical order of the exception class names.

Mvh,
Ole

> On Aug 9, 2022, at 11:16 AM, Thomas Sødring via nikita-noark <nikita-noark at nuug.no> wrote:
> 
> Godt spørsmål Ole! Dokumentasjon finnes på mange måter.
> 
> nikita skal støtte swagger/openapi beskrivelser. Feks det ser du i controller:
> 
> https://gitlab.com/OsloMet-ABI/nikita-noark5-core/-/blob/master/src/main/java/nikita/webapp/web/controller/hateoas/FondsHateoasController.java#L45
> 
> Det er mulig å starte nikita sammen med swagger-api beskrivelse. Men jeg har ikke løst samhandlings biten at du faktisk kan POSTE/PUT fra swagger.
> 
> Det er noe javadoc dokumentasjon. Feks
> 
> https://gitlab.com/OsloMet-ABI/nikita-noark5-core/-/blob/master/src/main/java/nikita/webapp/service/impl/FondsService.java#L83
> 
> men dette er også noe som burde blitt gjennomgått i mer detalj.
> 
> Nikita har integrert spring-restdocs-asciidoctor og når tester kjøres genereres det en https://asciidoctor.org/docs/ fil
> 
> Vi har desverre ikke hatt tid til å ta tak i dette og strømlinje det. 
> 
>  - Thomas
> 
> Fra: nikita-noark <nikita-noark-bounces at nuug.no> på vegne av ole at aamot.software <ole at aamot.software>
> Sendt: tirsdag 9. august 2022 11:05
> Til: Petter Reinholdtsen <pere at hungry.com>
> Kopi: nikita-noark at nuug.no <nikita-noark at nuug.no>
> Emne: Re: Er dokumentasjon relevant for arkiv?
>  
> On Aug 9, 2022 9:48 AM, Petter Reinholdtsen <pere at hungry.com> wrote:
> [Thomas Sødring]
> > Ble tilsendt følgende lenke fra en kollega på arkivstudiet:
> >
> >  https://www.kode24.no/artikkel/rolfs-beste-tips-for-god-dokumentasjon-i-dag-er-dette-ekstremt-viktig/76736767
> Takk for den.  En nyttig påminning og et godt mentalt rammeverk for å
> vurdere dokumentasjonsbehovet.
> Og javadoc benyttes naturligvis i Nikita?
> 
> Jeg fant en bok med tittelen
> 
> The Elements of Java Style
> 
> hvor javadoc er beskrevet på side 42.
> 
> Mvh,
> Ole
> 
> _______________________________________________
> nikita-noark mailing list
> nikita-noark at nuug.no
> https://lists.nuug.no/mailman/listinfo/nikita-noark