[ IDEA ] Añadir comentarios en las tareas

[Caravantes]

Hola.
Mientras estás haciendo una tarea tienes las ideas muy claras: sabes perfectamente cuál es el objetivo de la tarea, sabes para que sirve cada acción o bloque de acciones, sabes para qué sirve cada variable, etc.
Pero luego, meses o años después, puede que algunas de esas ideas ya no las recuerdes con claridad, especialmente si se trata de una tarea larga y compleja, con diferentes variables y distintas posibilidades (condiciones, bucles, etc). Y eso puede ser un problema cuando quieras revisar o mejorar algún detalle de la tarea.

Otros lenguajes de programación tienen opciones específicas para añadir comentarios en los que el programador escribe aclaraciones destinadas entender lo que hace el programa y cuáles son las finalidades de unos u otros detalles. Tasker no incluye ninguna opción específica para añadir comentarios, pero existe un truco para solventar esta carencia.

Todas las acciones de Tasker incluyen al final una opción para añadir una ETIQUETA. Aunque esa etiqueta se haya concebido como destino (u objetivo) de un salto (acción IR-A), podemos usar esa etiqueta para añadir un comentario. Me parece buena idea utilizar es etiqueta interna de una acción para añadir un comentario concreto sobre esa acción; por ejemplo para explicar el sentido de una variable, o el funcionamiento de una condición. A veces también se puede utilizar para añadir un comentario que no solo corresponde a esa acción individual, sino que el comentario afacta también a algunas otras acciones posteriores.

Además, Tasker incluye la "acción" ANCLA (Anchor, en inglés) que no hace nada y su único objetivo es precisamente insertar una ETIQUETA especialmente concebida como destino (u objetivo) de un salto (acción IR-A). Igualmente podemos usar esa etiqueta para añadir comentarios. Personalmente, utilizo esta posibilidad de la acción Ancla para añadir un comentario general al comienzo de la tarea, y a veces también en otros comentarios que afectan a un grupo importante de acciones, como explicar el funcionamiento de un bucle, por ejemplo.

En todos los casos, cuando tasker te muestra la tarea, la ETIQUETA (comentario) aparece justo antes de la propia acción que incluye esa etiqueta.

Todo esto es especialmente conveniente para tareas largas y complejas. Pero opino que es un buen hábito acostumbrarse a documentar y explicar todas las tareas, incluyendo las tareas iniciales que suelen ser pequeñas y sencilas. A veces ocurre que una tarea empieza siendo sencilla y con el tiempo le vas añadiendo más cosas y se acaba convirtiendo en una tarea compleja; por eso es preferible empezar a documentarla o explicarla desde que que empiezas a hacerla, incluso si es una tarea pequeña. Por otro lado, si adquieres este hábito incluso con las tareas pequeñas, luego ya te saldrá de forma natural cuando empieces a hacer tareas más ambiciosas.

Porsupuesto, puede haber personas con la cabeza bien amueblada y con buena memoria que no necesiten estas ayudas. Solo es una sugerencia desde mi experiencia y mi punto de vista. Y puede tener más importancia para tareas que vas a compartir con otras personas; por ejemplo, si las vas a publicar en un foro o en un repositorio de tareas para que otros internautas las puedan copiar o importar.

No he encontrado ninguna forma de comentar o documentar un perfil, salvo su propio nombre. [Edit: más abajo, en otro post, el compañero OSCONSE explica que se puede poner un comentario en las propiedades del perfil]

Añado tres capturas de pantalla de una tarea mía que tiene 52 acciones y 11 variables locales.

Anchor1.jpgAnchor2.jpgAnchor3.jpg

Se aceptan y agradecen opiniones, ideas alternativas, objeciones, etc.


P.D. Se me olvidaba comentar que las ETIQUETAS pueden añadir algo de código HTML. Por ejemplo,

<h1> significa "encabezado 1"; o sea que pone el texto a un tamaño mayor.
<font color=Green> significa que las letras deben estar en color verde.

Anchor4.jpgAnchor5.jpg

[Osconse]

Que buena idea!!!

De este modo se puede ir viendo el desarrollo de las tareas muy claramente y sobre todo saber que hace cada cosa.

Lo que no entiendo es por que prefieres el ancla, ya que es incluir acciones a la tarea que la hacen más larga y farragosa (a mi entender, ehh.) si en cada acción ya tiene las posibilidad de poner una etiqueta.

He probado ambas opciones y particularmente me gusta mas la opcion de poner una etiqueta en la acción, a no ser que haya algún truqui que se me escape del ancla.

Gracias!!!

[Caravantes]

Originalmente Escrito por Osconse

Lo que no entiendo es por que prefieres el ancla, ya que es incluir acciones a la tarea que la hacen más larga y farragosa (a mi entender, ehh.)

Bueno, no es una cuestión importante. Puedes prescindir del ancla y hacer los comentarios en las accciones que ejecutan la tarea, si eso te parece más simple y breve. Lo importante es la idea de añadir comentarios explicativos.

Independientmente de los comentarios, a la hora de programar, para iniciar un bucle tienes dos opciones:
A) poner el ancla-Etiqueta como inicio del bucle. Al final del bucle pones una acción IR-A:etiqueta (del ancla).
B) poner la etiqueta en la primera acción que realmente hace algo en el bucle, sin añadir una acción Ancla que puedes considerar innecesaria. Al final del bucle pones una acción IR-A:etiqueta (de la primera acción real del bucle)

Personalmene prefiero el método A), porque así independizo el inicio del bucle de la primera acción real que hace algo en el bucle. Vease la acción 31 (Ancla) en la tercera imagen. Por ejemplo, si luego quiero cambiar la primera acción que hace algo en el bucle (acción 32) o insertar otra acción delante de esa, el ancla sigue sirviendo como inicio del bucle sin necesidad de cambiar ninguna otra cosa.

A la hora de documentar e insertar comentarios, el argumento es muy similar. Al principio de la tarea prefiero poner un ancla con el comentario general sobre la tarea. Vease la acción número 1 (Ancla) en la primera imagen. Eso hace que el comentario sea independiente de la primera acción real (la número 2) que ejecuta algo en la tarea. Puedo cambiar esa primera acción real, o insertar otra delante, y sin embargo el comentario inicial sigue estando en su sitio, al comienzo de la tarea.

Pero fíjate en la segunda imagen. En la acción 24 hay un comentario que se refiere a las acciones 24 y 25. En la acción 26 hay un comentario que se refiere a las acciones 26 y 27. Y en la acción 28 hay un comentario que se refiere a las acciones 28, 29 y 30. Aunque son comentarios que se refieren a varias acciones, ahí no he añadido Anclas; he puesto el comentario en la primera acción del grupo, y seguramente lo he hecho por simplificar, por no añadir demasiadas anclas, tal como tú has pensado con buen criterio.

Se puede hacer de una forma u otra, según tu propio estilo y el interés que tengas en abreviar o mantener los comentarios separados de las acciones. Lo que me parece importante es añadir comentarios para que la tarea incluya sus propias explicaciones de forma que se entienda fácilmente incluso aunque haya pasado tiempo y ya no recuerdes por qué la hiciste así; o cuando la tarea esté siendo leída/utilizada por una persona distinta a quien la creó.

[Osconse]

Originalmente Escrito por Caravantes

Personalmene prefiero el método A), porque así independizo el inicio del bucle de la primera acción real que hace algo en el bucle. Vease la acción 31 (Ancla) en la tercera imagen. Por ejemplo, si luego quiero cambiar la primera acción que hace algo en el bucle (acción 32) o insertar otra acción delante de esa, el ancla sigue sirviendo como inicio del bucle sin necesidad de cambiar ninguna otra cosa.

De acuerdo, ahora lo veo mas claro. De la otra manera si cambias la acción que contiene el comentario, tiene que acordarte de poner otro comentario en la nueva acción.

Muchas gracias por la idea y por las aclaraciones.

[Osconse]

Voy a añadir algo que he descubierto y que seguramente vosotros ya conoceréis, pero me ha parecido muy útil para poner orden:

Si dejas pulsado el nombre de un perfil, aparecen unas opciones en la parte superior derecha de la pantalla, donde una de ellas es una rueda dentada (PROPIEDADES DEL PERFIL)

Ahí hay un campo llamado "comentarios" donde se puede poner una explicación más detallada de TODO lo que hace el perfil.

Dejo un ejemplo.

[Caravantes]

Originalmente Escrito por Osconse

Ahí hay un campo llamado "comentarios" donde se puede poner una explicación más detallada de TODO lo que hace el perfil.

Pues yo no lo conocía y me has dado una alegría. De hecho, en el primer post escribí con cierta tristeza: "No he encontrado ninguna forma de comentar o documentar un perfil, salvo su propio nombre".

Muchas gracias por esa excelente aportación al hilo.

[Osconse]

Jajaja, me alegra haber aportado algo al foro.

No todo va a ser recibir...