> Profe: ¿CÓMO HAGO LAS ESPECIFICACIONES?

Vos sos muy complicado para hablar y das muchos rodeos. Acá te mando algunos ejemplos.

        Adolfo
               ///

==============================================================================

    /* Para poder insertar un nuevo valor a la Lista debe cumplirse la in_*/
    /* variante de la misma                                               */

ESTE COMENTARIO SOBRA, pues TODOS los métodos necesitan que se cumpla la invariante (salvo el constructor).


    /*--------------------------------------------------------------------*/
    /*  Método para realizar el intercambio de los valores que contiene un*/
    /*  nodo de posición 1 y un nodo de posición 2                        */
    /*--------------------------------------------------------------------*/

Es mejor ésto:

- Intercambia los valores almacenados en las posiciones "i" & "j".
- La posición de un valor en la lista es la cantidad de valores que están antes que
  él, comenzando desde el primer valor: por eso la posición del primer valor es 0.

==============================================================================

La mía:

bool cont_Lista::Compare(
    int "i", int "j" // cuáles valores comparar
){
/*  resultado
    Compara los valores de posición "i" && "j"
    - Retorna "true" si el de posición "i" es menor el otro
    - Retorna "false" en el caso contrario (mayor o igual).

La tuya:
    bool cont_Lista::mayor_menor(int pos1, int pos2){
    /*--------------------------------------------------------------------*/
    /* Valores que recibe: pos1 y pos2;numeración de los nodos en la Lista*/
    /* Valor que devuelve: el valor lógico (booleano) generado a partir   */
    /* de la comparación de los valores que almacenen dos nodos ubicados  */
    /* en las posiciones pos1 y pos2 desde el primer nodo                 */
    /*--------------------------------------------------------------------*/

==============================================================================

La mía:

void cont_Lista::Imprimir() {
/*  resultado
    Graba en "cout" los valores de "*this"
*/

La tuya:

   void cont_Lista::imprimir(){
    /*--------------------------------------------------------------------*/
    /* Método encargado de imprimir en pantalla los valores almacenados en*/
    /* el campos _Val de cada uno de los nodos del contenedor             */
    /*--------------------------------------------------------------------*/

------- Forwarded message follows -------

From:       Pipino Cuevas <bananito@hotmail.com>
To:         Adolfo Di Mare <adolfo@di-mare.com>
Subject:    CI-1201-Documentación Interna
Date sent:  Sun, 13 Jun 2004 12:52:34 -0600

Profe,
     Yo aún tengo cierto inconveniente en cuanto a lo que documentación interna se refiere. A veces me parece que la realizo de manera insuficiente; pero a veces me parece que la documentación que hago tiende a ser un poco excesiva. A continuación le muestro un trozo de código de la tarea 8 donde tengo documentados algunos métodos:

//==========================================================================

    void cont_Lista::Insertar(int _Val){
    /*--------------------------------------------------------------------*/
    /* Insertar un nuevo valor a la Lista                                 */
    /* Para poder insertar un nuevo valor a la Lista debe cumplirse la in_*/
    /* variante de la misma                                               */
    /*--------------------------------------------------------------------*/

    void cont_Lista::intercambia(int pos1, int pos2){
    /*--------------------------------------------------------------------*/
    /*  Método para realizar el intercambio de los valores que contiene un*/
    /*  nodo de posición 1 y un nodo de posición 2                        */
    /*--------------------------------------------------------------------*/
       Nodo * p1 = _prm;                  /* Puntero a cont_Lista::Nodo   */
       Nodo * p2 = _prm;                  /* Puntero a cont_Lista::No     */

    bool cont_Lista::mayor_menor(int pos1, int pos2){
    /*--------------------------------------------------------------------*/
    /* Valores que recibe: pos1 y pos2;numeración de los nodos en la Lista*/
    /* Valor que devuelve: el valor lógico (booleano) generado a partir   */
    /* de la comparación de los valores que almacenen dos nodos ubicados  */
    /* en las posiciones pos1 y pos2 desde el primer nodo                 */
    /*--------------------------------------------------------------------*/
       Nodo * p1 = _prm;                    /* Puntero a cont_Lista::Nodo */
       Nodo * p2 = _prm;                    /* Puntero a cont_Lista::Nodo */
       int i = 0;
       for (i = 0;i < pos1; ++i)            /* Ubica nodo n£mero pos1     */
           p1 = p1->next;
       for (i = 0; i < pos2; ++i)           /* Ubica nodo n£mero pos2     */
           p2 = p2->nex 

   void cont_Lista::imprimir(){
    /*--------------------------------------------------------------------*/
    /* Método encargado de imprimir en pantalla los valores almacenados en*/
    /* el campos _Val de cada uno de los nodos del contenedor             */
    /*--------------------------------------------------------------------*/
       Nodo * p = _prm;                 /* Puntero al primer nodo         */
       while(p){
           cout << p->_Val << " ";      /* Realizar recorrido de la lista */
           p = p->next;                 /* para la impresión de cada _Val */
       }
       cout << "\n";
    }
    int cont_Lista::get_NumCampos(){
    /*--------------------------------------------------------------------*/
    /* Este método no recibe ningún valor                                 */
    /* Valores que devuelve: total de elementos (nodos) de la lista       */
    /*--------------------------------------------------------------------*/
        return totCamp;
    }
//==========================================================================
    La idea de enviarle esto se centra en que como en las tareas de documentación no recibimos muchas correcciones en cuanto a la documentación interna, ya que lo que se hace es publicarla por Internet, me interesaría conocer de una manera más específica en qué fallan mis documentaciones. Talvés las realizo de una manera muy poco técnica,  o talvés documento procesos muy evidentes. Agradecería cualquier observación al respecto.

------- End of forwarded message -------