<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<style type="text/css" style="display:none;"> P {margin-top:0;margin-bottom:0;} </style>
</head>
<body dir="ltr">
<div style="font-family: Calibri, Arial, Helvetica, sans-serif; font-size: 12pt; color: rgb(0, 0, 0);" class="elementToProof">
Det er interessant Ole. Jeg lurer på hvor mye av *hvem* (altså @author/forfatter) egentlig styres fra git framfor statiske kommentarer i kode. </div>
<div style="font-family: Calibri, Arial, Helvetica, sans-serif; font-size: 12pt; color: rgb(0, 0, 0);" class="elementToProof">
<br>
</div>
<div style="font-family: Calibri, Arial, Helvetica, sans-serif; font-size: 12pt; color: rgb(0, 0, 0);" class="elementToProof">
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!</div>
<div style="font-family: Calibri, Arial, Helvetica, sans-serif; font-size: 12pt; color: rgb(0, 0, 0);" class="elementToProof">
<br>
</div>
<div style="font-family: Calibri, Arial, Helvetica, sans-serif; font-size: 12pt; color: rgb(0, 0, 0);" class="elementToProof">
En relevant diskusjon på dette er å finne på SO (<a href="https://stackoverflow.com/questions/17269843/javadoc-author-tag-good-practices" id="LPNoLPOWALinkPreview">https://stackoverflow.com/questions/17269843/javadoc-author-tag-good-practices</a>)</div>
<div style="font-family: Calibri, Arial, Helvetica, sans-serif; font-size: 12pt; color: rgb(0, 0, 0);" class="elementToProof">
<br>
</div>
<div style="font-family: Calibri, Arial, Helvetica, sans-serif; font-size: 12pt; color: rgb(0, 0, 0);" class="elementToProof">
Denne posten (<a href="https://stackoverflow.com/questions/3730679/does-source-code-management-make-javadocs-author-and-since-redundant" id="LPNoLPOWALinkPreview_1">https://stackoverflow.com/questions/3730679/does-source-code-management-make-javadocs-author-and-since-redundant</a>)
på <span style="background-color:rgb(255, 255, 255);display:inline !important">har </span>SO også noen gode tanker.</div>
<div style="font-family: Calibri, Arial, Helvetica, sans-serif; font-size: 12pt; color: rgb(0, 0, 0);" class="elementToProof">
<br>
</div>
<div style="font-family: Calibri, Arial, Helvetica, sans-serif; font-size: 12pt; color: rgb(0, 0, 0);" class="elementToProof">
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.</div>
<div style="font-family: Calibri, Arial, Helvetica, sans-serif; font-size: 12pt; color: rgb(0, 0, 0);" class="elementToProof">
<br>
</div>
<div style="font-family: Calibri, Arial, Helvetica, sans-serif; font-size: 12pt; color: rgb(0, 0, 0);" class="elementToProof">
- Thomas</div>
<div class="_Entity _EType_OWALinkPreview _EId_OWALinkPreview_1 _EReadonly_1"></div>
<br>
<div class="_Entity _EType_OWALinkPreview _EId_OWALinkPreview _EReadonly_1"></div>
<div style="font-family: Calibri, Arial, Helvetica, sans-serif; font-size: 12pt; color: rgb(0, 0, 0);" class="elementToProof">
<br>
</div>
<div id="appendonsend"></div>
<hr style="display:inline-block;width:98%" tabindex="-1">
<div id="divRplyFwdMsg" dir="ltr"><font face="Calibri, sans-serif" style="font-size:11pt" color="#000000"><b>Fra:</b> Ole Aamot <ole@aamotsoftware.no><br>
<b>Sendt:</b> onsdag 10. august 2022 12:55<br>
<b>Til:</b> Thomas Sødring <tsodring@oslomet.no><br>
<b>Kopi:</b> nikita-noark@nuug.no <nikita-noark@nuug.no><br>
<b>Emne:</b> Re: Er dokumentasjon relevant for arkiv?</font>
<div> </div>
</div>
<div class="BodyFragment"><font size="2"><span style="font-size:11pt;">
<div class="PlainText">Boken beskriver javadoc på side 42:<br>
<br>
SUN MICROSYSTEMS recommends the following Javadoc tag ordering:<br>
<br>
In classes and interface descriptions:<br>
<br>
/** <br>
* Description.<br>
*<br>
* @author<br>
* @version<br>
*<br>
* @see<br>
* @since<br>
* @deprecated<br>
*/<br>
<br>
Consider including an @author and @version tag in every class or interface description.<br>
<br>
List multiple @author tags in chronological order, with the class or interface creator<br>
listed first.<br>
<br>
In method descriptions:<br>
<br>
/**<br>
* Description.<br>
*<br>
* @param<br>
* @return<br>
* @exception<br>
*<br>
* @see<br>
* @since<br>
* @deprecated<br>
*/<br>
<br>
Include a @param tag for every parameter. List multiple @param tags in parameter declaration order.<br>
<br>
Include a @return tag if the method returns any type other than void.<br>
<br>
Include an @exception tag for every checked exception listed in a throws clause.<br>
Include an @exception tag for every unchecked exception that a user may reasonably expect to catch.<br>
List multiple @exception tags in alphabetical order of the exception class names.<br>
<br>
Mvh,<br>
Ole<br>
<br>
> On Aug 9, 2022, at 11:16 AM, Thomas Sødring via nikita-noark <nikita-noark@nuug.no> wrote:<br>
> <br>
> Godt spørsmål Ole! Dokumentasjon finnes på mange måter.<br>
> <br>
> nikita skal støtte swagger/openapi beskrivelser. Feks det ser du i controller:<br>
> <br>
> <a href="https://eur02.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgitlab.com%2FOsloMet-ABI%2Fnikita-noark5-core%2F-%2Fblob%2Fmaster%2Fsrc%2Fmain%2Fjava%2Fnikita%2Fwebapp%2Fweb%2Fcontroller%2Fhateoas%2FFondsHateoasController.java%23L45&data=05%7C01%7Ctsodring%40oslomet.no%7C794d3b342c344ac591d208da7abeca47%7Cfec81f12628645508911f446fcdafa1f%7C0%7C0%7C637957257106185290%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=q7Yuy%2BWvnJX0Tp%2BO8BXBNf%2FhYx4oCMw0Q3RijjXHa2Q%3D&reserved=0">
https://eur02.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgitlab.com%2FOsloMet-ABI%2Fnikita-noark5-core%2F-%2Fblob%2Fmaster%2Fsrc%2Fmain%2Fjava%2Fnikita%2Fwebapp%2Fweb%2Fcontroller%2Fhateoas%2FFondsHateoasController.java%23L45&data=05%7C01%7Ctsodring%40oslomet.no%7C794d3b342c344ac591d208da7abeca47%7Cfec81f12628645508911f446fcdafa1f%7C0%7C0%7C637957257106185290%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=q7Yuy%2BWvnJX0Tp%2BO8BXBNf%2FhYx4oCMw0Q3RijjXHa2Q%3D&reserved=0</a><br>
> <br>
> 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.<br>
> <br>
> Det er noe javadoc dokumentasjon. Feks<br>
> <br>
> <a href="https://eur02.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgitlab.com%2FOsloMet-ABI%2Fnikita-noark5-core%2F-%2Fblob%2Fmaster%2Fsrc%2Fmain%2Fjava%2Fnikita%2Fwebapp%2Fservice%2Fimpl%2FFondsService.java%23L83&data=05%7C01%7Ctsodring%40oslomet.no%7C794d3b342c344ac591d208da7abeca47%7Cfec81f12628645508911f446fcdafa1f%7C0%7C0%7C637957257106341516%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=J5ZTAl9iY3xRsB3gsBxdXL%2FyCV70tJ2o%2FWz8ONW8UgQ%3D&reserved=0">
https://eur02.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgitlab.com%2FOsloMet-ABI%2Fnikita-noark5-core%2F-%2Fblob%2Fmaster%2Fsrc%2Fmain%2Fjava%2Fnikita%2Fwebapp%2Fservice%2Fimpl%2FFondsService.java%23L83&data=05%7C01%7Ctsodring%40oslomet.no%7C794d3b342c344ac591d208da7abeca47%7Cfec81f12628645508911f446fcdafa1f%7C0%7C0%7C637957257106341516%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=J5ZTAl9iY3xRsB3gsBxdXL%2FyCV70tJ2o%2FWz8ONW8UgQ%3D&reserved=0</a><br>
> <br>
> men dette er også noe som burde blitt gjennomgått i mer detalj.<br>
> <br>
> Nikita har integrert spring-restdocs-asciidoctor og når tester kjøres genereres det en
<a href="https://eur02.safelinks.protection.outlook.com/?url=https%3A%2F%2Fasciidoctor.org%2Fdocs%2F&data=05%7C01%7Ctsodring%40oslomet.no%7C794d3b342c344ac591d208da7abeca47%7Cfec81f12628645508911f446fcdafa1f%7C0%7C0%7C637957257106341516%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=78U075ciMDTn%2BSK%2B89tVHoX4SDzLMIhFf3O%2BniHlgvc%3D&reserved=0">
https://eur02.safelinks.protection.outlook.com/?url=https%3A%2F%2Fasciidoctor.org%2Fdocs%2F&data=05%7C01%7Ctsodring%40oslomet.no%7C794d3b342c344ac591d208da7abeca47%7Cfec81f12628645508911f446fcdafa1f%7C0%7C0%7C637957257106341516%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=78U075ciMDTn%2BSK%2B89tVHoX4SDzLMIhFf3O%2BniHlgvc%3D&reserved=0</a>
fil<br>
> <br>
> Vi har desverre ikke hatt tid til å ta tak i dette og strømlinje det. <br>
> <br>
> - Thomas<br>
> <br>
> Fra: nikita-noark <nikita-noark-bounces@nuug.no> på vegne av ole@aamot.software <ole@aamot.software><br>
> Sendt: tirsdag 9. august 2022 11:05<br>
> Til: Petter Reinholdtsen <pere@hungry.com><br>
> Kopi: nikita-noark@nuug.no <nikita-noark@nuug.no><br>
> Emne: Re: Er dokumentasjon relevant for arkiv?<br>
> <br>
> On Aug 9, 2022 9:48 AM, Petter Reinholdtsen <pere@hungry.com> wrote:<br>
> [Thomas Sødring]<br>
> > Ble tilsendt følgende lenke fra en kollega på arkivstudiet:<br>
> ><br>
> > <a href="https://eur02.safelinks.protection.outlook.com/?url=https%3A%2F%2Fwww.kode24.no%2Fartikkel%2Frolfs-beste-tips-for-god-dokumentasjon-i-dag-er-dette-ekstremt-viktig%2F76736767&data=05%7C01%7Ctsodring%40oslomet.no%7C794d3b342c344ac591d208da7abeca47%7Cfec81f12628645508911f446fcdafa1f%7C0%7C0%7C637957257106341516%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=vun4Yn62D1lPqPqgPJ1mFehEIVQ0LpRh4JpJpndjR0o%3D&reserved=0">
https://eur02.safelinks.protection.outlook.com/?url=https%3A%2F%2Fwww.kode24.no%2Fartikkel%2Frolfs-beste-tips-for-god-dokumentasjon-i-dag-er-dette-ekstremt-viktig%2F76736767&data=05%7C01%7Ctsodring%40oslomet.no%7C794d3b342c344ac591d208da7abeca47%7Cfec81f12628645508911f446fcdafa1f%7C0%7C0%7C637957257106341516%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=vun4Yn62D1lPqPqgPJ1mFehEIVQ0LpRh4JpJpndjR0o%3D&reserved=0</a><br>
> Takk for den. En nyttig påminning og et godt mentalt rammeverk for å<br>
> vurdere dokumentasjonsbehovet.<br>
> Og javadoc benyttes naturligvis i Nikita?<br>
> <br>
> Jeg fant en bok med tittelen<br>
> <br>
> The Elements of Java Style<br>
> <br>
> hvor javadoc er beskrevet på side 42.<br>
> <br>
> Mvh,<br>
> Ole<br>
> <br>
> _______________________________________________<br>
> nikita-noark mailing list<br>
> nikita-noark@nuug.no<br>
> <a href="https://eur02.safelinks.protection.outlook.com/?url=https%3A%2F%2Flists.nuug.no%2Fmailman%2Flistinfo%2Fnikita-noark&data=05%7C01%7Ctsodring%40oslomet.no%7C794d3b342c344ac591d208da7abeca47%7Cfec81f12628645508911f446fcdafa1f%7C0%7C0%7C637957257106341516%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=RKWKIBewKofdslXvlgWcqH6Us1HVZblnGhba%2BLyHGcI%3D&reserved=0">
https://eur02.safelinks.protection.outlook.com/?url=https%3A%2F%2Flists.nuug.no%2Fmailman%2Flistinfo%2Fnikita-noark&data=05%7C01%7Ctsodring%40oslomet.no%7C794d3b342c344ac591d208da7abeca47%7Cfec81f12628645508911f446fcdafa1f%7C0%7C0%7C637957257106341516%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=RKWKIBewKofdslXvlgWcqH6Us1HVZblnGhba%2BLyHGcI%3D&reserved=0</a><br>
</div>
</span></font></div>
</body>
</html>