Articles of documentation

Où documenter les fonctions en C?

J’ai un programme C avec plusieurs fichiers, donc j’ai, par exemple, stuff.c qui implémente quelques fonctions, et stuff.h avec les prototypes de fonctions. Comment dois-je procéder pour documenter les fonctions dans les commentaires? Dois-je avoir tous les documents dans le fichier d’en-tête, tous les documents dans le fichier .c , ou dupliquer les documents pour […]

Générer la documentation Protobuf?

Est-ce que quelqu’un connaît un bon outil pour générer de la documentation Google Protobuf en utilisant les fichiers sources .proto?

Comment convaincre les gens de commenter leur code

Quels sont les bons arguments pour convaincre les autres de commenter leur code? Je remarque que beaucoup de programmeurs préfèrent la vitesse perçue de l’écriture du code sans commentaires, en laissant de la documentation pour eux-mêmes et pour les autres. Quand j’essaie de les convaincre, j’entends des choses à moitié cuites comme «le nom de […]

Fonctions multiples dans un fichier .Rd

Version courte : Puis-je émuler la documentation de Normal dans les stats package en utilisant roxygen ? Version longue : Je travaille sur un paquet et essayais de rendre la documentation plus lisible en ayant un certain nombre de fonctions avec des entrées / parameters communs collectés sous un seul titre, ce qui sera une […]

Documentation WebForm_PostBackOptions

Existe-t-il une documentation sur les parameters de WebForm_PostBackOptions? Je ne trouve rien chez Google.

Comment append des commentaires au niveau du package dans Javadoc?

J’utilise Check-Style, FindBugs et PMD pour valider mon code Java. J’ai corrigé presque tous les bugs détectés par ces outils. Je ne suis pas capable de comprendre comment écrire “commentaire de paquet” qui est un bug pris par checkstyle. J’ai parcouru la documentation de Check-Style, mais je ne le comprends pas. Quelqu’un pourrait-il m’aider à […]

Application (pas un langage de balisage) pour la production d’un manuel utilisateur

Quelqu’un peut-il recommander un programme pour créer des manuels d’utilisation avec? Pas un langage de balisage (comme LaTeX ou DocBook), mais plutôt quelque chose d’interactif comme Scribus. Comme je ne suis pas le seul à mettre à jour le manuel, le logiciel devrait être quelque chose de facile à prendre en main pour un novice, […]

Comment puis-je lister les modules / classes / constantes / méthodes non documentés avec yardoc?

J’ai une petite bibliothèque de code que je documente avec YARD . Lorsque je lance la commande yardoc , cela me dit: Files: 40 Modules: 14 ( 0 undocumented) Classes: 39 ( 0 undocumented) Constants: 21 ( 4 undocumented) Methods: 239 ( 31 undocumented) 88.82% documented Au lieu de parcourir tout mon code pour trouver […]

Documentation hors ligne pour différents langages de programmation?

J’ai récemment trouvé ceci: http://php.net/get/php_manual_en.chm/from/a/mirror . C’est un fichier .chm qui contient toute la documentation de PHP que vous pouvez normalement trouver sur leur site. Pratique pour une utilisation hors ligne. Je me demande si quelqu’un connaît des choses similaires pour d’autres langues. Complétez la documentation hors ligne que vous pouvez utiliser si vous n’avez […]

Lors de la documentation dans Roxygen: Comment créer une liste détaillée dans @details?

Quelle est la syntaxe appropriée pour append une liste détaillée à roxygen2, par exemple, dans la section @details? Puis-je créer un environnement de liste de latex? Il semble que les sauts de ligne soient simplement ignorés, c.-à-d. #’ @details text describing parameter inputs in more detail #’ #’ parameter 1: stuff #’ #’ parameter 2: […]