/
Inicio :: Foros

 F.A.Q.F.A.Q.                  Conéctese para revisar sus mensajesConéctese para revisar sus mensajes   

Duda sobre documentacion en c

 
      Índice del Foro elrincondelc.com -> C/C++ en General
Ver tema anterior :: Ver siguiente tema  
AutorMensaje
March



Registrado: 16 Nov 2005
Mensajes: 24

MensajePublicado: 15/03/2008 11:33 am
Título: Duda sobre documentacion en c

Que tal, tengo una pregunta.
En diversos archivos que he descargado con el tiempo, he visto documentacion (o informacion general, mas que documentacion) de este tipo:

Código:
/*    $Id: archivo.h, v 1.0 2008/03/15$

   Author:       Pepe Gomez
    E-mail:       
    Copyright (C): 2008, Pepe Gomez
    
   This program is free software; you can redistribute it ...
*/

existe alguna norma, o convenciones para estos comentarios?, por ejemplo, tienen algun significado los '$' en la primer linea?
Volver arriba
digies



Registrado: 18 Nov 2005
Mensajes: 1001
Ubicación: Blumenau (Br)

MensajePublicado: 15/03/2008 5:07 pm
Título:

Supongo que según el lenguaje de programación utilizado (C/C++, Java, etc.), cada uno tiene su estilo o forma de documentar el código fuente, pero en líneas generales todos tienen casi la misma similitud. Recuerdo que cuando programaba en Java con Eclipse, este me generaba automáticamente los títulos de la documentación como así también el año, etc. Algunos editores de texto (como el que incluye el Dev-Cpp) disponen de algunas opciones para agregar el título de autor y fecha de creación. Un ejemplo típico para documentar un código fuente es:
Código:

/**
@title:
@author:
@copyright:
...
*/

Creo que esto debería servir también para C/C++, pero también es válido como está puesto en tu ejemplo.
Te dejo algunos enlaces donde se proponen varios ejemplos y se explican algunas normas o convenciones:
Documentador de Código Fuente



Un saludo
Volver arriba
Killrazor



Registrado: 24 Ene 2006
Mensajes: 1284
Ubicación: Barcelona

MensajePublicado: 20/03/2008 1:20 am
Título:

Documentar es importante pero mas alla del nombre de quien escribe el codigo. Te aconsejo documentadores como Doxygen que van muy bien y hacen una documentacion muy seria.
_________________
I wanna heal i wanna feel like I'm close to something real.
I wanna find something I've wanted all along
somewhere i belong
Volver arriba
      Índice del Foro elrincondelc.com -> C/C++ en General
Página 1 de 1Todas las horas están en GMT - 8 Horas

 
No puede crear mensajes
No puede responder temas
No puede editar sus mensajes
No puede borrar sus mensajes
No puede votar en encuestas

(c) ElRincondelC.com

Un proyecto de UrlanHeat.com