SV: nikita-noark Digest, Vol 63, Issue 5

Thu Aug 11 12:11:07 CEST 2022

"En liten epistelhistorie fra IT-verden: Facebook v/Zuckerberg, n? Meta, Inc., kj?pte opp lokalene til SUN MICROSYSTEMS i Menlo Park, og snudde skiltet til SUN og satte opp Like-ikonet i 1 Hacker Way." 

En kommentar til denne. Jeg var på besøk på Facebooks hovedkontor i 2014 i 2 til 3 timer (besøksregistreringen foregikk i Facebook og jeg har masse bilder). Fetteren min jobbet der som innleid konsulent. Det var ikke bare der hvor man hadde spor etter Sun Microsystems. I møterom og i de øvrige lokalene var det mange Sun-logoer og påminnelser om hvem som hadde holdt til der før. I følge fetteren min skyldes det at Mark Zukerberg ville minne de ansatte om hva som skjedde med Sun for at det samme ikke skulle skje med Facebook

/martin 

-----Opprinnelig melding-----
Fra: nikita-noark <nikita-noark-bounces at nuug.no> På vegne av nikita-noark-request at nuug.no
Sendt: torsdag 11. august 2022 12:00
Til: nikita-noark at nuug.no
Emne: nikita-noark Digest, Vol 63, Issue 5

Send nikita-noark mailing list submissions to
	nikita-noark at nuug.no

To subscribe or unsubscribe via the World Wide Web, visit
	https://lists.nuug.no/mailman/listinfo/nikita-noark
or, via email, send a message with subject or body 'help' to
	nikita-noark-request at nuug.no

You can reach the person managing the list at
	nikita-noark-owner at nuug.no

When replying, please edit your Subject line so it is more specific than "Re: Contents of nikita-noark digest..."

Today's Topics:

   1. Re: Er dokumentasjon relevant for arkiv? (Ole Aamot)

----------------------------------------------------------------------

Message: 1
Date: Wed, 10 Aug 2022 15:34:57 +0200
From: Ole Aamot <ole at aamotsoftware.no>
To: Thomas S?dring <tsodring at oslomet.no>
Cc: "nikita-noark at nuug.no" <nikita-noark at nuug.no>
Subject: Re: Er dokumentasjon relevant for arkiv?
Message-ID: <885F9253-C5A3-46EC-AD63-BBB8453309C5 at aamotsoftware.no>
Content-Type: text/plain;	charset=utf-8

Hei igjen Thomas,

Jeg har kun litt erfaring med ? dokumentere med gtk-doc i C, men jeg kan sikkert bidra med ? dokumentere litt i javadoc i l?pet av h?sten 2022, hvis jeg l?rer meg stilen for javadoc ved ? lese spesifikasjonen fra SUN MICROSYSTEMS og Best Practises via lenken som du oppgav.

En liten epistelhistorie fra IT-verden: Facebook v/Zuckerberg, n? Meta, Inc., kj?pte opp lokalene til SUN MICROSYSTEMS i Menlo Park, og snudde skiltet til SUN og satte opp Like-ikonet i 1 Hacker Way.

Mvh,
Ole Aamot

> On Aug 10, 2022, at 1:47 PM, Thomas S?dring <tsodring at oslomet.no> wrote:
> 
> Det er interessant Ole. Jeg lurer p? hvor mye av *hvem* (alts? @author/forfatter) egentlig styres fra git framfor statiske kommentarer i kode. 
> 
> Noe h?res hjemme hos versjonsh?ndtering (git), noe kan v?re i kode. Jeg m? bare innr?mme at jeg har ikke tid til ? holde kommentarer oppdatert i nikita (selv om jeg burde). Grunnen til det er tid!
> 
> En relevant diskusjon p? dette er ? finne p? SO 
> (https://stackoverflow.com/questions/17269843/javadoc-author-tag-good-
> practices)
> 
> Denne posten (https://stackoverflow.com/questions/3730679/does-source-code-management-make-javadocs-author-and-since-redundant) p? har SO ogs? noen gode tanker.
> 
> Et annet aspekt med nikita er bruken av @NotNull. Jeg har brukt det for liberalt og har det overalt, mens det egentlig skal kun brukes p? interface (definisjon av klasser) og ikke i implementasjonen av klassen. Jeg synes det var greit ? se de overalt, men etterhvert opplevde jeg de som st?y.
> 
>  - Thomas
> 
> 
> Fra: Ole Aamot <ole at aamotsoftware.no>
> Sendt: onsdag 10. august 2022 12:55
> Til: Thomas S?dring <tsodring at oslomet.no>
> Kopi: nikita-noark at nuug.no <nikita-noark at nuug.no>
> Emne: Re: Er dokumentasjon relevant for arkiv?
>  
> 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://eur02.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgi
> > tlab.com%2FOsloMet-ABI%2Fnikita-noark5-core%2F-%2Fblob%2Fmaster%2Fsr
> > c%2Fmain%2Fjava%2Fnikita%2Fwebapp%2Fweb%2Fcontroller%2Fhateoas%2FFon
> > dsHateoasController.java%23L45&data=05%7C01%7Ctsodring%40oslomet
> > .no%7C794d3b342c344ac591d208da7abeca47%7Cfec81f12628645508911f446fcd
> > afa1f%7C0%7C0%7C637957257106185290%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiM
> > C4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%
> > 7C%7C&sdata=q7Yuy%2BWvnJX0Tp%2BO8BXBNf%2FhYx4oCMw0Q3RijjXHa2Q%3D
> > &reserved=0
> > 
> > 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://eur02.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgi
> > tlab.com%2FOsloMet-ABI%2Fnikita-noark5-core%2F-%2Fblob%2Fmaster%2Fsr
> > c%2Fmain%2Fjava%2Fnikita%2Fwebapp%2Fservice%2Fimpl%2FFondsService.ja
> > va%23L83&data=05%7C01%7Ctsodring%40oslomet.no%7C794d3b342c344ac5
> > 91d208da7abeca47%7Cfec81f12628645508911f446fcdafa1f%7C0%7C0%7C637957
> > 257106341516%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2l
> > uMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=J5ZTAl
> > 9iY3xRsB3gsBxdXL%2FyCV70tJ2o%2FWz8ONW8UgQ%3D&reserved=0
> > 
> > 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 
> > enhttps://eur02.safelinks.protection.outlook.com/?url=https%3A%2F%2F
> > asciidoctor.org%2Fdocs%2F&data=05%7C01%7Ctsodring%40oslomet.no%7
> > C794d3b342c344ac591d208da7abeca47%7Cfec81f12628645508911f446fcdafa1f
> > %7C0%7C0%7C637957257106341516%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLj
> > AwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C
> > &sdata=78U075ciMDTn%2BSK%2B89tVHoX4SDzLMIhFf3O%2BniHlgvc%3D&
> > reserved=0 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://eur02.safelinks.protection.outlook.com/?url=https%3A%2F%2F
> > > www.kode24.no%2Fartikkel%2Frolfs-beste-tips-for-god-dokumentasjon-
> > > i-dag-er-dette-ekstremt-viktig%2F76736767&data=05%7C01%7Ctsodr
> > > ing%40oslomet.no%7C794d3b342c344ac591d208da7abeca47%7Cfec81f126286
> > > 45508911f446fcdafa1f%7C0%7C0%7C637957257106341516%7CUnknown%7CTWFp
> > > bGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVC
> > > I6Mn0%3D%7C3000%7C%7C%7C&sdata=vun4Yn62D1lPqPqgPJ1mFehEIVQ0LpR
> > > h4JpJpndjR0o%3D&reserved=0
> > 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://eur02.safelinks.protection.outlook.com/?url=https%3A%2F%2Fli
> > sts.nuug.no%2Fmailman%2Flistinfo%2Fnikita-noark&data=05%7C01%7Ct
> > sodring%40oslomet.no%7C794d3b342c344ac591d208da7abeca47%7Cfec81f1262
> > 8645508911f446fcdafa1f%7C0%7C0%7C637957257106341516%7CUnknown%7CTWFp
> > bGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6
> > Mn0%3D%7C3000%7C%7C%7C&sdata=RKWKIBewKofdslXvlgWcqH6Us1HVZblnGhb
> > a%2BLyHGcI%3D&reserved=0

------------------------------

Subject: Digest Footer

_______________________________________________
nikita-noark mailing list
nikita-noark at nuug.no
https://lists.nuug.no/mailman/listinfo/nikita-noark

------------------------------

End of nikita-noark Digest, Vol 63, Issue 5
*******************************************