Tutoriel par Examples: documenter



Le nom enum n'est pas toujours suffisamment clair pour être compris. Pour documenter un enum , utilisez javadoc standard: /** * United States coins */ public enum Coins { /** * One-cent coin, commonly known as a penny, * is a unit of currency equaling one-hundredth ...
Pour documenter une fonction, il est souvent utile d'avoir un exemple de script qui utilise votre fonction. La fonction de publication dans Matlab peut ensuite être utilisée pour générer un fichier d'aide contenant des images, du code, des liens, etc. intégrés. La syntaxe de documentation d...
Ecrire avec roxygen2 roxygen2 est un package créé par Hadley Wickham pour faciliter la documentation. Il permet d'inclure la documentation dans le script R, dans les lignes commençant par #' . Les différents paramètres transmis à la documentation commencent par un @ , par exemple le créat...
#lang scribble/manual @; Make sure that code highlighting recognises identifiers from my-package: ꩜require[@for-label[my-package]] @; Indicate which module is exporting the identifiers documented here. @defmodule[my-package] @defproc[(my-procedure [arg1 number?] [arg2 string?]) symbol?]{ ...

Page 1 de 1