Wulin.com (www.vevb.com) Introducción al artículo: Nunca he visto ninguna investigación científica probar esto, pero en el campo de software, es como un dogma o una creencia común. Debido a su existencia, es importante escribir software fácilmente y prestar atención al tipo de código legible. Estos requisitos se pueden lograr a través de algunas técnicas, una de las cuales es escribir comentarios de código.
Descargo de responsabilidad: lo que dije sobre cómo evitar los comentarios de código no significa que no escriba comentarios, lo que significa que evito escribir comentarios de código tanto como sea posible, pero aún así los escribo cuando siento que vale la pena.
Pasamos más tiempo leyendo software que escribir software, y nunca he visto ninguna investigación científica probar esto, pero en el campo de software, es como un dogma o una creencia común. Debido a su existencia, es importante escribir software fácilmente y prestar atención al tipo de código legible. Estos requisitos se pueden lograr a través de algunas técnicas, una de las cuales es escribir comentarios de código.
Cuando se habla de comentarios de código, siempre hay un debate interminable. ¿Deberíamos usar comentarios para ilustrar el papel de nuestro código? ¿Deberíamos centrarnos en la expresividad del código sin necesidad de comentarios para ayudar en la lectura? Joe Kunk escribió un blog sobre el argumento, ¿no deberías escribir comentarios? Algunas personas dicen que el código bien documentado se considera un buen código, y algunos dicen que los comentarios deben evitarse porque los comentarios a menudo se usan para explicar/ocultar el código malo.
En mi opinión, bajo la influencia de los libros, para garantizar que el código sea ordenado y fácil de refactorizar, debemos evitar escribir comentarios a menos que tengamos una buena razón para escribir comentarios (como algoritmos matemáticos) o debido a los requisitos o procesos de la empresa, estamos obligados a hacerlo. Aquí hay cinco preocupaciones sobre las notas.
Donde creo que los comentarios del código funcionan contra los contraalfectos 1. Los comentarios a menudo fomentan el código maloEl código comentado es un buen código, hay tal dicho, por lo que las personas a menudo agregan comentarios al código para que el código sea hermoso. Si agregamos comentarios para interpretar el código, es como una señal: tal vez estamos escribiendo un código malo. Cuando queremos escribir un comentario, debemos preguntarnos si podemos hacerlo más legible limpiando el código.
2. Pasaremos más tiempo escribiendo y manteniendoLos comentarios suelen ser la segunda versión del código. En realidad nos estamos repitiendo cuando escribimos comentarios para una función. Violamos el principio seco (no te repites). Estamos pasando más tiempo y agregando complejidad. Si los requisitos cambian, el código también debe cambiar, y si escribimos comentarios, también debemos cambiarlos. Así que realiza un cambio por el doble de tiempo que pasa. Podemos usar este tiempo para mejorar nuestro código o desarrollar nuevas funciones.
3. Los comentarios no son comprobables y verificadosCuando modificamos el código, utilizamos compiladores, IDE y herramientas de prueba unitaria para ayudar, y no hay comentarios ni herramientas similares. No puede confiar en herramientas o pruebas unitarias para asegurarse de que se usen correctamente, anotaciones de fechas, etc. Una vez que escriba un comentario, porque es incondicional y no puede prestar atención a su precisión, se conservará sin detectar una vez que salga mal.
4. Los comentarios no son confiables en comparación con el códigoPor lo general, cuando los comentarios y el código salen de él, se vuelve menos significativo. Si un programador lo lee, se puede engañar. Incluso sin engañar, debe leer el código fuente para descubrir lo que está haciendo. Para un ejemplo práctico, si nuestro jefe necesita que hagamos una modificación, ¿deberíamos mirar los comentarios o el código? Por supuesto que veremos el código.
5. Los comentarios ocupan mucho espacio en la pantallaAlgunos métodos de comentarios (como el siguiente) toman muchas líneas, lo que se convierte en un problema cuando desea ver más código.
/**
*
* @param título El título del CD
* @param Autor El autor del CD
* @param rastrea el número de pistas en el CD
* @param DurationInsinmines la duración del CD en minutos
*/
public void addcd (título de cadena, autor de cadena,
int pistas, int durationInMinutes) {
CD CD = nuevo CD ();
cd.title = title;
cd.author = autor;
CD.tracks = pistas;
CD.Duration = Duración;
CDLIST.Add (CD);
}