Il y a tellement d'options dans chaque langages de programmation qui peuvent être mentionnées dans la documentation du code.Quels sont les éléments nécessaires à documenter sur le code?
Je veux savoir quels sont les éléments les plus importants que nous devons documenter?
Je documenterais des contrats (ce paramètre ne devrait pas être nul, cette fonction ne renvoie jamais de null, ...) ainsi que la signification (cette méthode fait cela, ...). En plus de documenter l'API, j'ajouterais des commentaires sur des morceaux de code qui ne sont pas triviaux mais qui ajoutent une valeur significative à l'application (cryptique mais très rapide, fonctionne autour d'un bug de framework).
Ce que vous document dépend en fin de compte un Lor sur qui liront cette documentation ...