Clara is een hulp-documentatie tool voor C ++ of Java-ontwikkelaars. Eigenlijk schildert ze een diagram - een clara diagram - van een klasse.
Met clara kunt u uw klas visualiseren alsof het een chip met pennen voor input - vertegenwoordigen de input parameters van de methoden - en pennen voor uitvoer - die de return type van de functies-.
Laten we eens kijken naar bijvoorbeeld het schema dat clara zou trekken voor de volgende C ++ sample klasse
class sampleInterface
{
public:
ongeldig init (MyStructure * pstruct);
leegte SETPOINT (float x, float y);
float getX ();
float getY ();
ongeldig processIt ();
};
Wat zijn deze pinnen voor? Gaan we ze een of andere manier te verbinden? Helemaal niet, het is gewoon een handige manier om te vertegenwoordigen wat de klasse biedt in een zeer compacte vorm.
Uiteraard het diagram wordt getrokken door clara automatisch behoeft (geen mogelijkheid) iets handmatig plaatsen.
Clara krijgt de benodigde informatie op twee manieren: met behulp van reflectie in java en ontleden van de header-bestand in C ++. Clara kan ook een call-diagram van de klasse te trekken als de bronnen zijn gevonden, nota al is dat voor de call-diagram een extra instrument nodig is (dot.exe van http://www.graphviz.org) en het moet apart geïnstalleerd.
Reacties niet gevonden