FTP | CCD | Buscar | Trucos | Trabajo | Foros |
|
Registrarse | FAQ | Miembros | Calendario | Guía de estilo | Temas de Hoy |
|
Herramientas | Buscar en Tema | Desplegado |
|
#1
|
||||
|
||||
Lo que no comprendo es el motivo de no querer poner comentarios, ¿qué más da?, a ver si piensan que el programa va más lento por eso
No conozco ninguna utilidad que te sirva, y además veo difícil que exista, porque si no quieren comentarios, como mínimo se tendría que permitir usar "marcas" que sirvieran para enlazar con un fichero externo. Pero si no quieren comentarios entonces es seguro que tampoco quieren "marcas". Sería algo parecido a los bookmark, que se almacenan en un fichero aparte la línea, tú podrías incluir el comentario además de la línea. Pero claro, sería un fichero que tendrías que cargar en memoria cuando abres el proyecto e ir actualizando los números de líneas según se va modificando el fuente. Algo engorroso, aunque posible. Código:
[UFmain] 100 comentario djfdjfdsjfj fjdlfjd 314 eaff udfoauof mm..m.ww [UFcuentas] 22 qerpueruwruewir rueoruwo 23 jdfjafj oiuoerjwelrjew 988 jdkejr ekrjerjejr Creo que he servido de poca ayuda. |
#2
|
||||
|
||||
Cita:
Cita:
Pienso igual que Casimiro. ¿Qué sentido tiene eliminar los comentarios del código? ¿Cual es el problema? Si es por temas de legibilidad y estáis usando versiones nuevas, tal vez podríais usar la directiva REGION.
__________________
Germán Estévez => Web/Blog Guía de estilo, Guía alternativa Utiliza TAG's en tus mensajes. Contactar con el Clubdelphi P.D: Más tiempo dedicado a la pregunta=Mejores respuestas. |
#3
|
||||
|
||||
Creo que estamos ante un despropósito.
No encuentro la relación entre un proyecto con una buena cantidad de formularios y la necesidad de que su código no lleve comentarios. Al contrario, diría que entre más grande es un proyecto, más cuidado se debe tener de que esté debidamente comentado (aparte de la documentación externa al código fuente). Eso del código autoexplicativo es un concepto con trampa. El código fuente es escrito en un lenguaje que está entre el entendimiento normal humano (un idioma) y la capacidad de análisis de un compilador o intérprete. Se escribe de tal manera que el humano pueda entenderlo, pero concediendo algunas facilidades para que el compilador o intérprete haga su trabajo. En Delphi, por ejemplo, si escribiésemos el código fuente en inglés normal, sería muy complicado disponer de un compilador capaz de transformar el texto del programa en código máquina. En el otro extremo, si escribiésemos el código solamente con ceros y unos (para una asimilación automática por parte de la computadora), resultaría prácticamente imposible que un programador pudiera leerlo con plena comprensión. Por ello es que siempre programamos en un lenguaje "intermedio": algo que el compilador pueda procesar, pero que también el humano pueda leer. Claro está, este código fuente debe escribirse de forma comprensible, pero por más claro y ordenado que se encuentre, en muchas ocasiones hará falta algo adicional para quien intente leer ese código fuente, así sea otro programador o el mismo autor tiempo después. Y ese algo adicional son precisamente los comentarios que acompañan al código. Los comentarios resultan sumamente prácticos porque están ahí, justo al lado del código fuente (arriba, debajo, al costado). Un programador abre un archivo y debe ser capaz de entender (contexto previamente analizado) las sentencias de una rutina, por las sentencias mismas y, ante alguna duda o confusión, por los comentarios que ahí están. Incluso con frecuencia basta, es más rápido y requiere menor esfuerzo neuronal leer el comentario que se encuentra arriba de un If, que el If mismo con todas sus condiciones. Un comentario fuera del código fuente no es un comentario, es documentación. Pero por más rica que sea la documentación, no se compara con la oportunidad de comprender un bloque de instrucciones debidamente comentado, in situ. Lepe, yo buscaría convencer a quienes han solicitado eso de lo inadecuado que sería. Buen martes a todos. Al González. Última edición por Al González fecha: 27-09-2011 a las 17:11:33. |
#4
|
||||
|
||||
En alguna ocasión he pensado en algo parecido a lo que piden los superiores de Lepe. En mi caso, esa idea extrema, ha sido después de observar siempre los mismos comentarios tipo:
O por el lío que genera no identar el código fuente, cabeceras al inicio del documento desactualizadas, etc. Pero hay veces que es necesario hacer comentarios en el propio código fuente. Ahora mismo me acabo de encontrar con el problema de hacer DisableControls en una relación maestro/detalle entre dos TClientDataSet y he añadido un comentario para avisar de usar BlockReadSize. En mi caso suelo utilizar subversión y con cada commit añado información de porqué he hecho modificaciones. No sé si eso te podría servir. Saludos!
__________________
Si no lo sabes, necesitas leerlo |
#5
|
||||
|
||||
Antes de nada quiero agradecer vuestros comentarios, como siempre, magníficos.
Neftali y Al González: Sí, es un despropósito, lo sé, pero es lo único que se me ocurre para salir del paso. En realidad son muchas cosas las que tenemos pendiente en el cajón (migrar a XE con Firebird 2.5, por ejemplo). El REGION me gustó del XE, ya me gustaría poder usarlo en D7 jejeje. dec:: conocía de oídas el DelphiDoc, al ser Open Source, le echaré una visual. Casimiro: Mi jefe es programador Delphi con más de 20 años de experiencia, único programador del proyecto. Creo es más bien una cuestión de gustos. No puedo dar más detalles, tampoco es que hayamos tenido una conversación larga y tendida sobre el tema, solo hizo un comentario y prefiero molestar lo mínimo. Esos comentarios a él no le sirven porque conoce TODO, (hasta la última coma) del proyecto [créeme, cuando digo hasta la última coma]. Mi idea es precisamente la que tú comentas, pero además del número de línea, guardaría un trozo de texto del código (con 1 Tera de Disco duro eso es lo de menos), así puedo abrir una ventanita de Cnpacks automáticamente mostrando el comentario en una ventana adosada (docked) o flotando donde no moleste. DarKraZY: Uso Tortoise en un repositorio local, se lo he comentado, pero como no tenemos tiempo, no hemos sacado tiempo para ponerlo en marcha. Como tiene comprado el XE, en cuanto migremos el proyecto lo usaremos fijo. En realidad no me lo han pedido, es algo que quiero hacer para "aclararme yo". Tengo que dejar aparcado esto un par de días, miraré las opciones más detenidamente. Gracias y un Saludo.
__________________
Si usted entendió mi comentario, contácteme y gustosamente, se lo volveré a explicar hasta que no lo entienda, Gracias. |
#6
|
||||
|
||||
Tendrá memoria fotográfica.
|
#7
|
||||
|
||||
Cita:
Hay que tener en cuenta muchas cosas; Me parece bastante fácil que en un momento se "descuadre" esa relación e imagino la cantidad de trabajo perdido. Todo el fichero de comentarios quedaría invalidado, toda esa información perdida. Por no decir qué pasaría si se utiliza algún sistema de control de versiones. ¿Dónde se guardarían esos ficheros? Habría que sincronizarlos también. ¿Qué pasaría con el fichero al hacer un Check-in/Check-out? Hay alunas herramientas que permiten adjuntar ficheros a uno de código o añadirlo a la misma familia (tal vez eso podría ser una solución), pero no se si todos tienen esa posibilidad.
__________________
Germán Estévez => Web/Blog Guía de estilo, Guía alternativa Utiliza TAG's en tus mensajes. Contactar con el Clubdelphi P.D: Más tiempo dedicado a la pregunta=Mejores respuestas. |
#8
|
||||
|
||||
Sí, fácil no sería, y las posibilidades de "estropicio" son muchas.
Pero es que lo fácil, rápido y cómodo es poner comentarios en el código. Si el jefe tiene memoria fotográfica, pues mejor para él, pero no puede exigir a los demás que la tengan. Algún día puede que sufra de alzeimer o que se pegue un porrazo en la bañera y se le olvide el código, ¿y ahora qué? No quiero dar ideas, Lepe |
#9
|
||||
|
||||
Por suerte para mí, él es usuario de este foro también.
__________________
Si usted entendió mi comentario, contácteme y gustosamente, se lo volveré a explicar hasta que no lo entienda, Gracias. |
#10
|
||||
|
||||
Pues entonces, mejor
Cita:
|
#11
|
||||
|
||||
Cuantos más seamos mejor... ;-)
A ver si se anima y nos da su opinión.
__________________
Germán Estévez => Web/Blog Guía de estilo, Guía alternativa Utiliza TAG's en tus mensajes. Contactar con el Clubdelphi P.D: Más tiempo dedicado a la pregunta=Mejores respuestas. |
#12
|
||||
|
||||
A ver si no resulta que Lepe es su propio jefe
// Saludos |
#13
|
||||
|
||||
No sin antes haber leído las nuestras.
Lepe, ¿ya le referiste este hilo a tu jefe? |
#14
|
||||
|
||||
no, no quiero que me despida para contratar a alguien con memoria fotográfica
__________________
Si usted entendió mi comentario, contácteme y gustosamente, se lo volveré a explicar hasta que no lo entienda, Gracias. Última edición por Lepe fecha: 29-09-2011 a las 19:13:01. Razón: aclarar un poco :D |
|
|
Temas Similares | ||||
Tema | Autor | Foro | Respuestas | Último mensaje |
synedit como comentar codigo con Ctrl + } | JXJ | Varios | 3 | 08-03-2010 02:35:38 |
Mirar por favor este query y comentar... | El_Raso | Firebird e Interbase | 33 | 18-11-2008 12:53:44 |
Rapido con Delphi, y Lento desde fuera de delphi | JoseQ | Varios | 0 | 08-09-2005 10:54:48 |
Si Delphi desapareciera y todo fuera .NET... | Al González | Debates | 18 | 05-09-2005 18:56:29 |
|