Podem fer-ho així:
Retorna la suma d’a i b
Paràmetres: |
|
---|---|
Retorna: | Un enter resultat de sumar a i b |
Tipus de retorn: | |
int |
Una vegada documentada, la funció es pot referenciar des de qualsevol lloc del text usant una construcció com aquesta suma2(). D’aquesta manera es facilita notablement a l’usuari la consulta de la documentació, especialment si ho fa on-line.
De forma automàtica la funció s’afegeix a l’índex.
També tenim facilitats per documentar mòduls. En aquest cas l’estratègia és:
Plataformes: GNU/Linux
Aquest mòdul conté una llista extensa de funcions que permeten fer sumes amb diverses possibilitats mes o menys recargolades.
Paràmetres: | l (list) – Una llista d’enters |
---|---|
Return int: | La suma dels enters d’l |
Paràmetres: | l (list) – Una llista d’enters |
---|---|
Retorna: | La suma dels enters d’l |
Tipus de retorn: | |
int |
i mes