Startpagina / Samenvattingen / Objectgeoriënteerd programmeren in Java 1 / tag-return-programma

Documenteren

Q: Geef de algemene vorm van de @param en @return tag.

@param parameternaam beschrijving @return beschrijving

10 belangrijke vragen over Documenteren

Hoe noemt men tekst die enkel binnen het programma zichtbaar is en tekst dat ook buiten het programma is

binnen het programma is commentaar, buiten het programma is documentatie

Waar staat commentaar voor de programmeur.

In de specificatie en tussen de code door.

Uit wat bestaat de specificatie van een methode.

beschrijving van het specifieke effect van de methode
beschrijving evnetuel bijzonderheden van parameters en terugkeerwaarde
signatuur van de methode

Hoe neemt men commentaar op die later met javadoc documentatie genereert.

/**
*
*/

Uit welke twee delen bestaat javadoc-commentaar.

Uit een samenvattende zin (eventueel een extra beschrijving) en één of meer tags.

Welke tag gebruikt men voor parameters te beschrijven.

@param

Welke tag gebruikt men om een auteur aan te duiden.

@author

Welke tag gebruikt men om de terugkeerwaarde te beschrijven.

@return

Geef de algemene vorm van de @param en @return tag.

@param parameternaam beschrijving

@return beschrijving

Geef de conventies voor het documenteren van zelf ontworpen klassen.

gebruik javadoc
samenvattende beschrijving voor klasse gebruiken
voor public methoden beschrijf je wat de methode doet, de parameters en de return waarde.
Algemene informatie komt in de tekst voor het eerste punt, specifieke informatie komt na het eerste punt of in de @param en @return
voorwaarden worden in de specifieke informatie gezet

De vragen op deze pagina komen uit de samenvatting van het volgende studiemateriaal:

Objectgeoriënteerd programmeren in Java 1 | H J Sint, et al

Bekijk samenvatting

Een unieke studie- en oefentool
Nooit meer iets twee keer studeren
Haal de cijfers waar je op hoopt
100% zeker alles onthouden

Onthoud sneller, leer beter. Wetenschappelijk bewezen.

Documenteren

10 belangrijke vragen over Documenteren

Hoe noemt men tekst die enkel binnen het programma zichtbaar is en tekst dat ook buiten het programma is

Waar staat commentaar voor de programmeur.

Uit wat bestaat de specificatie van een methode.

Hoe neemt men commentaar op die later met javadoc documentatie genereert.

Uit welke twee delen bestaat javadoc-commentaar.

Welke tag gebruikt men voor parameters te beschrijven.

Welke tag gebruikt men om een auteur aan te duiden.

Welke tag gebruikt men om de terugkeerwaarde te beschrijven.

Geef de algemene vorm van de @param en @return tag.

Geef de conventies voor het documenteren van zelf ontworpen klassen.

Samenvattingen die gerelateerd zijn aan De code van visuele klassen

Objectgeoriënteerd programmeren in Java 1

Recht en efficiëntie : een inleiding in de e…

Beginselen van het Nederlandse staatsrecht

Pia Pia Método di Papiamentu

Object georienteerd programmereren in Java 2

Wiswijs

Basisboek journalistiek

Objectgeorienteerd programmeren in Java 1

Sociale hygiëne.

Cognitive development and learning in instru…

Nederland in de prehistorie. Revised ed.

Beleidsinstrumentatie