Je suis sur le point de quitter un projet, et avant de partir, mon patron m'a demandé de documenter le code (je n'ai pas très bien documenté). Ce n'est pas grave, le projet n'est pas terriblement complexe. Mais je trouve des endroits dans ma documentation où je voudrais dire: "Remarquez en ligne XYZ que tel ou tel se produit."
Dans ce cas, il n'est pas logique de faire référence à un numéro de ligne spécifique, car l'ajout ou la suppression d'une seule ligne de code surpasserait immédiatement la documentation. Existe-t-il des meilleures pratiques pour faire référence à une ligne de code spécifique sans y faire référence par numéro de ligne?
J'ai envisagé de joncher le code de commentaires comme:
/* linetag 38FECD4F */
Où "38FECD4F" est une balise unique pour cette ligne spécifique. Ensuite, je peux mettre dans la documentation, "Sur la ligne étiquetée '38FECD4F', notez que tel ou tel se produit."
D'autres idées? Je pense qu'il est généralement préférable de documenter les unités de code dans leur ensemble, plutôt que des parties spécifiques d'entre elles, mais dans le cas de ce projet particulier, il existe de LONGUES andains de code procédural, qui n'ont jamais été refondus en unités plus petites.