cla.cpp: Classe C++


dcl

CLA: Classe 

dtd

CLA -- Classi 

Nome

Il nome della classe. Se nested o apparitene ad un name space si usano i caratteri ":::" come separatori.

Titolo

La descrizione breve della classe.

Sistema

Sistema di apparteneza della classe

Il complesso dei documenti di una classe č formata da:

  1. Un documento cla, che comprende il codice relativo alla dichiarazione della classe.
  2. Uno o pių documenti fun, che documentano le funzioni pių importanti.
  3. Uno o pių documenti kon, che documentano le costanti della classe.

Non č comodo descrivere il funzionamento complesso di una classe all'interno del suo header. Se l'utilizzo o la struttura di una classe sono particolarmente complessi č molto meglio documentarla con uno o pių documenti dst. In particolare sono utili documentii con esempi di utilizzo. Non č neppure consigliabile documentare ogni singolo metodo. In molti casi la documentazione finisce con il superare il codice.

La documentazione completa della classe viene dunque composta prelevando diversi documenti dagli header hpp e dai sorgenti di implmentazione cpp.

Non sono migrabili

I link verso comprendono i seguenti dcl:

  • dst, eventuale documentazione estesa della classe.
  • fun, metodi appartenenti alla classe.
  • kon, costanti appartenenti alla classe.
  • cla, ale classi.

I link da comprendono i seguenti dcl:

  • dst, eventuale documentazione estesa della classe.
  • fun, metodi appartenenti alla classe.
  • kon, costanti appartenenti alla classe.
  • cla, ale classi.

I tag, v. Cla -- Classi, vengono preparati all'interno degli header --- files con suffisso .h o .hpp --- che descivono la classe.

dsu.pio.dcl.cla.cpp • LastModified: 14-9-2007 • John Peter Arnold