Me encuentro escribiendo (con suerte) comentarios útiles en el código (C ++) documentación del tipo:
The reason we are doing this is...
La razón por la que uso "nosotros" en lugar de "yo" es porque escribo muchos textos académicos donde a menudo se prefiere "nosotros".
Así que aquí está la pregunta. ¿Existe una buena razón para preferir uno sobre el otro en el código de documentación:
- Use "Nosotros": la razón por la que estamos haciendo esto es ...
- Usar "I": la razón por la que hago esto es ...
-
Usar mi nombre: El motivo
[my name]
hizo esto ... - Voz pasiva: la razón por la que se hizo esto es ...
- Ninguno: Haz esto porque ...
Elijo el # 1 porque estoy acostumbrado a escribir de esa manera, pero la documentación no es para el escritor, es para el lector, por lo que me pregunto si agregar el nombre del desarrollador es útil o si simplemente agrega otra cosa. que debe modificarse al mantener el código.