2010-10-01 25 views
0

Je documente actuellement du code en C++, et l'une des méthodes que j'entends écrire va trier un tableau. Il ne créera pas un nouveau tableau, cependant, il va trier les éléments du tableau donné en place. Je veux inclure une remarque du genre "si l'ordre original était important pour vous, alors n'utilisez pas cette méthode!" Mais je dirais plutôt quelque chose comme "trie le tableau donné ... statiquement?! ... dangereusement! ... avec des mutations !!!" que les programmeurs comme vous seraient en mesure de comprendre.Quelles sont les méthodes qui affectent leurs paramètres explicites?

Quel mot décrit ce genre de méthode?

Question supplémentaire: quelqu'un peut-il recommander un outil pour C++ qui crée une documentation HTML à partir de commentaires spécialement formatés, comme javadoc? Mon système d'exploitation de prédilection est Ubuntu.

Modifier: Je suis un étudiant et ma tâche est de trier.

Répondre

8

Trie le tableau donné sur place.

Vous connaissez std::sort et std::stable_sort, n'est-ce pas?

3

N'est-il pas évident qu'une fonction modifie les paramètres parce qu'ils sont transmis en tant que références non const? (Bouchon éhonté: voir this answer pour ce que le type de paramètre exact signifie.)

Et vous cherchez doxygen.

+0

Je suis étudiante: on commente tout! – Ziggy

0

Vous l'avez déjà dit: le terme correct est "mutateur".