Bonjour,
Y a-t-il une convention concernant l'emplacement de la documentation ? Est-il préférable de la faire de le fichier .h et/ou .c ? Dans le cas où il est suffisant de l'écrire dans le fichier .h, est-il nécessaire de mettre une référence à chaque fonction comme pratiqué dans util.c ? ("// see util.h" pour chaque fonction)
Merci d'avance,
Jonas
Bonjour,
Il n'y a pas vraiment de convention universelle adoptée par la communauté C. Je dirais que chacun définit sa propre convention et la suit à sa guise. C'est à vous de voir si vous voulez adopter ou pas la manière dont le projet est documenté. Cela dit, lorsque vous rejoignez une entreprise en industrie, vous êtes généralement tenu de respecter la convention en vigueur. Quoi qu'il en soit, le plus important est de rester cohérent et de commenter le code.
Merci !
Follow the pulses of EPFL on social networks
© 2023 EPFL, all rights reserved