Atari Computer

Beispiel: Kommentartemplate

Das folgende Beispiel zeigt mögliche Kommentarblöcke, mit denen Funktionen und Module versehen werden können. Dies soll zumindest ein Mindestmaß an zusätzlichen Informationen bieten.

Sprache	C
Definitionen	template.h
Beispiel	template.c

template.h

/**********************************************************************\
* Dateiname: <>
* Autor    : <>
* Projekt  : <>
*
* Copyright (C) <>
*
* Kurzbeschreibung: <>
*
* Datum:     Autor:       Grund der Aenderung:
* <>  <>    Neuerstellung
* <>  <>    <>
*
\**********************************************************************/

#ifndef <>
#define <>

/*--- #includes der Form <...> ---------------------------------------*/

/*--- #includes der Form "..." ---------------------------------------*/

/*--- #define-Konstanten und Makros ----------------------------------*/

/*--- Datentypen (typedef) -------------------------------------------*/

/*--- Globale Konstanten (extern) ------------------------------------*/

/*--- Globale Variablen (extern) -------------------------------------*/

/*--- Prototypen globaler Funktionen ---------------------------------*/

#endif /* <> */

template.c

/**********************************************************************\
* Dateiname: <>
* Autor    : <>
* Projekt  : <>
*
* Copyright (C) <>
*
* Kurzbeschreibung: <>
*
* Datum:     Autor:       Grund der Aenderung:
* <>  <>    Neuerstellung
* <>  <>    <>
*
\**********************************************************************/

/*--- #includes der Form <...> ---------------------------------------*/

/*--- #includes der Form "..." ---------------------------------------*/

/*--- #define-Konstanten und Makros ----------------------------------*/

/*--- Datentypen (typedef) -------------------------------------------*/

/*--- Globale Konstanten ---------------------------------------------*/

/*--- Globale Variablen ----------------------------------------------*/

/*--- Modullokale Konstanten -----------------------------------------*/

/*--- Modullokale Variablen ------------------------------------------*/

/*--- Prototypen modullokaler Funktionen -----------------------------*/

/*--- Funktionsdefinitionen ------------------------------------------*/

int main(int argc, char *argv[])   /* loeschen, falls nicht benoetigt */
{
   return 0;
}

/**********************************************************************\
* Funktionsname: <>
*
* Kurzbeschreibung:
*
* Parameter:
* <> : <>
* <> : <>
*
* Rueckgabewert: <>
* <> : <>
* <> : <>
*
\**********************************************************************/

English version not yet available.