Dans les commentaires, je dis habituellement soit "ceci" ou "nous-même" (parce que j'écris généralement des commentaires à la première personne du pluriel, mais "nous-mêmes" est trop bizarre quand il n'y a qu'un seul objet).
Dans la documentation, je dis "le <whatever>
". Si c'est ambigu (parce que la fonction en prend une autre en paramètre, par exemple), je dis "cet objet", ou "ceci <whatever>
".<whatever>
est soit le nom de la classe, soit un autre terme utilisé dans la documentation pour expliquer ce que la classe représente.
/**
* An utterly useless write-only counter, with arbitrary initial value.
*/
class Counter {
unsigned int count;
public:
/**
* Increments the counter
*/
Counter &operator++() {
// We need to add 1 to ourself. I found a snippet online that does it:
++count;
// return ourself
return *this;
}
/**
* Adds together this counter and "other".
*/
Counter operator+(const Counter &other) const {
Counter result;
// new count is our count plus other count
result.count = count + other.count;
return result;
}
};
Juste un peu de nit-pickery, mais l'opérateur +() devrait certainement être implémenté comme une fonction libre, auquel cas il n'y a pas d'objet "courant". –
J'utilise habituellement 'rhs' et pas' other', parce que c'est l'objet de droite, et cela meinte facilement avec le 'lhs' vs' rhs' que j'utilise pour les fonctions libres plus tard. –