8
Estoy buscando una respuesta bastante arbitraria, por lo que esto podría ser más una discusión. Me pregunto cuál es la mejor práctica para comentar mi código C# en Visual Studio. En este momento estoy usando el triple /// para generar el xml y uso el castillo de arena para construir un archivo chm o html. Pero mi problema es que utilizo comentarios de código por dos razones:código de comentario C# visual studio mejor práctica
- Cuando otros desarrolladores usan mi código, pueden leer la documentación, tanto intellisence como chm. o archivo html
- Pero también uso comentarios como recordatorios para mí. Así que puedo recordar mis pensamientos cuando vuelvo medio año después, a algunos métodos complejos.
¿Cómo se pueden lograr ambos objetivos sin interferir entre sí, y al mismo tiempo ser una tarea rápida, sin tomar demasiado tiempo de codificación?
Gracias por la respuesta. Creo que todos tenemos el problema del duelo porque nos pagan por nuestro trabajo, así que tenemos que crear un buen código y no utilizar demasiadas horas para escribirlo. A veces, los comentarios pueden usarse como una solución rápida y sucia para esto. Y sé que esto no es una buena práctica :) – DNRN
Estoy de acuerdo contigo. Siempre hay una compensación entre la buena calidad y la economía. Ciertamente escribo comentarios como "// TODO: No olvides refactorizar esto" o "// HACK: arreglar más tarde" yo mismo :-) Por supuesto depende del tipo de proyecto, pero a menudo me encuentro escribiendo código que tiene para mantener durante muchos años (a menudo por otras personas que yo) y en ese caso, realmente vale la pena a largo plazo cuando me preocupo por escribirlo. Cuando escribo un prototipo me tomo mucho menos cuidado, por supuesto. – Steven
@DNRN: Hablando de economía, ¿has oído hablar del concepto de "deuda técnica"?La idea es que si pospone la refactorización para una fecha posterior, en realidad está adquiriendo deuda técnica que tendrá que pagarse en el futuro, con interés. El interés en este caso es la sobrecarga de recordar lo que hace el código. En su lugar, recomiendo una herramienta de refactorización de calidad, como ReSharper o CodeRush, que hace que el trabajo de refactorización sea extremadamente eficiente. Usando una herramienta como esa, obtienes lo mejor de ambos mundos ... refactor ahora sin el tiempo extra. –