Estoy buscando un formato de documentación de clase informativa para mis clases de Entidad, Lógica de Negocios y Acceso a Datos.
Encontré los siguientes dos formatos de aquí
Formato 1
///-----------------------------------------------------------------
/// Namespace: <Class Namespace>
/// Class: <Class Name>
/// Description: <Description>
/// Author: <Author> Date: <DateTime>
/// Notes: <Notes>
/// Revision History:
/// Name: Date: Description:
///-----------------------------------------------------------------
Formato 2
// ===============================
// AUTHOR :
// CREATE DATE :
// PURPOSE :
// SPECIAL NOTES:
// ===============================
// Change History:
//
//==================================
Siento que los siguientes son los elementos básicos
- Autor
- Fecha de creación
- Descripción
- Historial de revisiones
ya que el nombre del espacio de nombres y de la clase estará allí de todos modos.
Hágame saber sus opiniones, qué formato se recomienda y si existe una forma estándar de escribir el historial de revisiones.