Preguntas etiquetadas con comments

Preguntas sobre cómo escribir comentarios en código.






17
¿TODOS los comentarios tienen sentido? [cerrado]
Estoy trabajando en un proyecto bastante grande y tuve la tarea de hacer algunas traducciones para él. Hubo toneladas de etiquetas que no se han traducido y mientras buscaba el código encontré este pequeño fragmento de código //TODO translations Esto me hizo pensar en el sentido de estos comentarios para …

9
Comentarios de código limpio vs documentación de clase
Estoy teniendo algunas conversaciones con mis nuevos colegas sobre los comentarios. A ambos nos gusta Clean Code , y estoy perfectamente de acuerdo con el hecho de que los comentarios de código en línea deben evitarse y que los nombres de clase y métodos deben usarse para expresar lo que …

13
¿Puede el código comentado ser una documentación valiosa?
Escribí el siguiente código: if (boutique == null) { boutique = new Boutique(); boutique.setSite(site); boutique.setUrlLogo(CmsProperties.URL_FLUX_BOUTIQUE+fluxBoutique.getLogo()); boutique.setUrlBoutique(CmsProperties.URL_FLUX_BOUTIQUE+fluxBoutique.getUrl()); boutique.setNom(fluxBoutique.getNom()); boutique.setSelected(false); boutique.setIdWebSC(fluxBoutique.getId()); boutique.setDateModification(new Date()); boutiqueDao.persist(boutique); } else { boutique.setSite(site); boutique.setUrlLogo(CmsProperties.URL_FLUX_BOUTIQUE+fluxBoutique.getLogo()); boutique.setUrlBoutique(CmsProperties.URL_FLUX_BOUTIQUE+fluxBoutique.getUrl()); boutique.setNom(fluxBoutique.getNom()); //boutique.setSelected(false); boutique.setIdWebSC(fluxBoutique.getId()); boutique.setDateModification(new Date()); boutiqueDao.merge(boutique); } Hay una línea comentada aquí. Pero creo que aclara el código al hacer obvio cuál …




9
¿Qué significa XXX en un comentario? [cerrado]
¿Qué quiere decir la gente en general cuando ves XXXen un comentario? De vez en cuando, veo un comentario como este: # XXX - This widget really should frobulate the whatsit Por supuesto, puedo decir qué significa el comentario, pero ¿qué significa generalmente el XXX? ¿Está diciendo "Esto es un …



11
¿Por qué son /// los bloques de comentarios importantes?
Alguien dijo una vez que deberíamos prefijar todos nuestros métodos con los /// <summary>bloques de comentarios (C #) pero no explicó por qué. Comencé a usarlos y descubrí que me molestaban bastante, así que dejé de usarlos excepto para las bibliotecas y los métodos estáticos. Son voluminosos y siempre me …
49 c#  comments 

Al usar nuestro sitio, usted reconoce que ha leído y comprende nuestra Política de Cookies y Política de Privacidad.
Licensed under cc by-sa 3.0 with attribution required.