¿Pones "preposiciones?¿Tabulas tu código?

[DarkByte]

¿Sueles poner "preposiciones" a los nombres de los objetos? Ej: Un edit que va a contener una dirección ip, llamarlo eIp, o a un memo donde vamos a escribir un mensaje, llamarlo mmMensaje.

Yo por mi parte me es más fácil hacelo, pues después para acordarme del nombre solo tengo que pensar en qué objeto es y que funcion realiza.

Otra cosa: ¿Sueles hacer tabulaciones en el código?, por ejemplo:

If not IdTCPClient1.Connected = True Then 
   Exit 
Else
    Msg := IdTCPClient1.ReadLn('',5);
    mmMensaje.Lines.Add(Msg);

Esto hace más comprensible la lectura del código, pero la verdad es que yo no estoy acostumbrado. ¿Y vosotros?

[marcoszorrilla]

Yo utilizo ambas cosas, según he votado en la encuesta.

La indentación y la notación húngara y los comentarios, son imprescindibles para una relectura rápida de cualquier código.

Un Saludo.

[kinobi]

Yo he votado por tabulación y no usar preposiciones, pero me he equivocado. Tú te refieres a "preposiciones" (no me fijé en que lo habías entrecomillado) anteponiéndose al identificador y yo lo entendí como preposiciones, preposiciones (a, ante, cabe, con ...) Así que quita un voto de la segunda opción y súmalo a la tercera.

Por cierto, hace unas semanas se trató un tema similar (te lo comento DarkByte por si se te ha pasado): http://www.clubdelphi.com/foros/showthread.php?t=6177, donde delphi.com.ar daba la dirección de un documento de Borland sobre consejos para la codificación en Object Pascal: http://community.borland.com/article...,10280,00.html

Saludos.

[santana]

Yo utilizo ambas cosas. Como DarkByte, las 'preposiciones' para encontrar rapidamente una referencia al objeto que busco en un momento en que no recuerdo su nombre, la tabulación porque si no no me aclaro a simple vista. Eso sí que me resulta imprescindible, sobre todo si el código no es mío. Es una de las mejores costumbres que se deben adquirir. Lo otro ya es cuestión de las preferencias o costumbres de cada uno.
Los comentarios....es lo que siempre sueles dejar para después y luego se te pasa por falta de tiempo, asi que la intención es buena, pero lo hago menos a menudo de lo que debiera.
Saludos.

[PepeLolo]

Yo he votado ambas cosas y he de decir, que por motivos de obligado cumplimento, los comentarios los realizo antes de escribr código y para más inrí, lo debo de escribir para cada uno de los procedimientos eventos funciones que se escriban. Tengo un Code Insight con el formato que se debe rellenar de documentación. Sí os soy sincero y despues de cuatro años teniendo que realizar esta ardua tarea, tengo que reconocer que apenas se pierde tiempo siempre y cuando lo primero que se haga sea documentar.
Otro canto os cantaria cuando se debe hacer despues de escribir un programa.

Os paso un pequeñito ejemplo para que os hagais una ligera idea de como es la documentación ha realiar.

{
*Documentación*
*Nombre: USelVar
*Tipo: Unit
*Título: Consultas con distintos niveles y órdenes de agrupación de criterios
*Autor: AJAA INFOSERVICIOS U.S.Y.P. (Unidad de Soluciones y Proyectos)
*Descripción:
El objetivo de este módulo es facilitar al usuario un SISTEMA sencillo e
intuitivo para la REALIZACIÓN DE CONSULTAS DE ÍNDOLE ESTADÍSTICA que permita
el cruce entre diversas variables. Es posible totalizar los resultados según
diferentes criterios y órdenes relativos de agrupación, con la posibilidad de
cambiar la estructura de la consulta en tiempo de ejecución.
Dentro de cada criterio de consulta, el usuario puede definir diferentes
AGRUPACIONES o TRAMOS de valores individuales - según la naturaleza del
criterio - con respecto a los cuales se totalizarán los resultados de la
consulta. Se proporciona toda la funcionalidad necesaria para la creación y
edición de tales agrupaciones. El usuario dispone también de la posibilidad
de prescindir de tales agrupaciones personalizadas y seleccionar los elementos
particulares que figuran en los catálogos montenidos por la aplicación para
cada uno de los criterios. La enorme flexibilidad proporcionada para el diseño
de las consultas permite posibilidades de análisis de la información de gran
utilidad.
El conjunto de criterios, grupos y valores se muestra en forma de estructura
jerárquica arborescente en la parte izquierda de la pantalla. A la derecha
se presentan dos ListView's donde se visualiza el conjunto de grupos seleccio-
nados para realizar la consulta. La selección se realiza mediante drag&drop.
Cada uno de ellos se utiliza para un eje diferente (abscisas y ordenadas). El
número máximo de grupos que puede seleccionarse para el eje horizontal está
limitado por razones de espacio.
Se proporciona, finalmente, todo un conjunto de filtros ajustables por el
usuario para limitar el ámbito de la consulta.

*Modificaciones*

*Fecha:
*Autor:
*Descripción:
}

[Investment]

Tal y como he votado, Tabulo el código, pero no pongo "preposiciones" aunque si que suelo comentar lo que hace cada unidad,procedimiento o funcion. Un buen vicio que cogi cuando trabajaba con Pepelolo ;-)

[__cadetill]

Pues yo, como he votado, sólo tabulo. Nunca me ha gustado la notación húngara.

Lo que sí que es muy importante para una relectura del código (y que por desgracia no se suele hacer amenudo por falta de tiempo) es comentar el código que se escribe.

[roman]

He respondido ambas pero tomando un sentido muy flexible de "preposiciones", esto es, indento el código y doy nombres significativos a las variables, tipos de datos y funciones. La mayoría de veces es con un dialecto húngaro pero con excepciones: por ejemplo, nunca uso frmPrincipal para un formulario sino que uso MainForm o FormaPrincipal o algo así.

Ambas cosas son imprescindibles como puede observarse cuando en los foros se presenta código sin indentar.

En cuanto a los comentarios también se me hacen fundamentales y normalmente trato de ponerlos en un momento u otro. Y en muchas ocasiones comienzo con los comentarios ya que así describo el proceso que debe seguirse y ya mees más fácil después desarrollar el código.

// Saludos

[hecjona]

Yo uso ambos y realmente funciona cuando compartes codigo con otros programadores, he revisado codigos de terceros que usan ambas y me resulta mas facil seguir el codigo, de igual manera cuando otro programador ve mi codigo he experimentado que le es mas facil seguir mi codigo apesar de que aveces por tiempo no tenga los suficientes comentarios.

[DarkByte]

Tengo que acostumbrarme a comentar mi código... sinceramente, me entra flojera porque yo siempre recuerdo para qué servía cada cosa (incluso mi código de hace un par de años, aunque esos eran ShowMessage "Eres un primo" y similares).

Respecto a lo de no cambiar el nombre a algunos componentes , como comentaba Voutarks: Yo sí dejo algunos componentes sin preposición. No le veo sentido ponerle preposición a un TBevel si, este, no va a tener ninguna función especial, sería una pérdida de tiempo a mi entender.

[andres1569]

Yo hago las tres cosas; lo de identar, como apunta Voutarks, debería ser "obligatorio", y aprovecho para recomendar su uso cuando se mete código en estos foros, utilizando el tag code, para facilitar la lectura a los demás.

En cuanto a lo de usar prefijos, me parece algo muy beneficioso, ahora no tengo el Delphi aquí pero hace un tiempo instalé una herramienta que permite asignar estos prefijos a la propiedad Name (coloca en el Object Inspector, en dicha propiedad, un botoncito que lleva a un editor donde se puede personalizar el prefijo para cada tipo de componente).

Lo de los comentarios es muy recomendable aunque nunca he escrito novelas como PepeLolo , supongo que el ejemplo que pones no será el más común ..., buen lo acabo de releer y veo que va referido a la unit, por un momento pensé que acompañaba a una función.

Un saludo

[Nuria]

Hola Compis!

Para mí es fundamental que el código esté identado, se ve mucho más claro.

En cuanto a los prefijos, también los usos, pero yo al igual que DarkByte con los componentes que no suelo usarlos para nada a nivel de código, no les cambio el nombre.

Suelo poner comentarios, por que la verdad, es que cuando haces una aplicación más o menos te acuerdas de lo que haces y porque, pero cuando pasa un tiempo sin tocarla y tienes que modificar alguna cosa, pues cuesta un poco acordarte de todo ( sobre todo yo, que tengo 'mu' mala memoria ), así que procuro documentar bien las aplicaciones, aunque tardes más a la larga te facilita el trabajo.

Saludos!

[DarkByte]

Empezado por andres1569

hace un tiempo instalé una herramienta que permite asignar estos prefijos a la propiedad Name (coloca en el Object Inspector, en dicha propiedad, un botoncito que lleva a un editor donde se puede personalizar el prefijo para cada tipo de componente).

Vaya pedazo de utilidad, ¿Es gratuita?¿Dónde se encuentra?

[Gydba]

Voy a decir lo que dice la mayoría: hago las dos cosas

Me parece muy legible y además intuitivo para alguien que, por ejemplo, este externo al desarrollo de la aplicación.

Solo comento los puntos fuertes que puedan no quedar en claro lo que hacen. Lo que si comento con lujo de detalles son los procedimientos o funciones de gran importancia para la aplicación (lo hago con un ancabezado con la fecha, el programador, parámetros, etc.)

Las dos cosas adicionales que tengo que mencionar es que los nombres de variables, componentes y demás a los que se haga referencia desde el código los escribo en lenguaje universal (Inglés) por comodidad e internacionalización.

El otro punto fuerte es que utilizo constantes en la mayoría del código, lo hace muy legible y además son mas rápidas las modificaciones.

Eso es todo, saludos

[[Lepe]]

Hola compañeros de fatiga.

Como he votado, hago cambas cosas, aunque no sigo la notación húngara, mas bien la notación Leperiana coincide con la húngara en muchas casos, pero cuando no me acuerdo de la notación húngara, uso la Leperiana.

En cuanto a comentar.... hago igual que todos, comento las funciones importantes, y además, cuando hay muchos if anidados si pongo algo asi como:

if Fallo then
begin
  ....
  if ImposibleRecuperar then
  begin 
     ...
  end
  else  // imposibleRecuperar
  begin
     ....
  end
else // Fallo
begin 
  ...
end;

Supongo que ustedes tambien

Para comentar las Unidades o Procedimientos uso las GExpert, (recomendado por el foro )

Para aquellos que no lo usen, lo comento:
pulsando una secuencia de teclas, añade lineas comentadas (predefinibles) con lo que se desea
Ctrl +Alt +P ==> Procedimiento con parametros descripción y tal (que lo pone por defecto), encima de la definición del Procedimiento
Ctrl+ Alt +U ==> Comentar unidad (al principio, justo antes de Unit blah;

Lo que más uso es poner el raton encima de una palabra y dale a Ctrl + Alt + (Flecha arriba / abajo) y busca esa misma palabra por toda la unidad. Además del "Grep Search" que es más cómodo para mi que el que trae delphi.

Y.... el Ctrl + G ==> definicion de procedimientos en la unidad activa, para ir a cualquier procedure o function...

A parte de muchas cosas mas que tiene... Copia de seguridad del proyecto, Poner en letra capital la primera letra de variables y objetos ...etc. Producto cinco estrellas.

Eso junto con el "code insight" de delphi.... ayuda mucho. Como veis, aqui teneis a uno que le gusta mas el teclado que el roedor jejejeje.

Eaa, ya me quedé tranquilito

Saludos a la peña