Weiß jemand was eine Funktionsübersicht ist (Informatik)?

...komplette Frage anzeigen

2 Antworten

Wer Software zu implementieren hat, sollte vorweg mindestens ihr API - ihr sog. Application Programming Interface - spezifiziert haben. 

Man versteht darunter eine Auflistung und Beschreibung sämtlicher Funktionen, über die Applikationscode - oder auch Code, der später eine graphische Benutzeroberfläche implementieren wird - Zugriff auf jene Software haben wird.

Gutes Beispiel hierfür ist, was sich im Inhaltsverzeichnis auf Seite http://greiterweb.de/spw/xs_WissDB/5/24.htm#2 im Abschnitt 

Services offered by C_WissDB_API

findet. Doppelclick auf einen der dort genannten Funktionsnamen führt zur Spezifikation der Funktion in Form einer sog. Responsibility Card.

Lies auch: http://greiterweb.de/spw/wie_docugestalten.htm ( wo skizziert ist, wie man heute Software-Architektur am besten beschreibt).


123Studi 16.07.2017, 02:09

achso ok.. danke für deine Antwort :)

0

Eine Funktionsübersicht sollte die Funktionen deiner Software übersichtlich und zusammengefasst darstellen. Neben dem Funktionsnamen und einer parametisierten Syntax mitsamt der zugehörigen Datentypen für einen Funktionsaufruf, sollte eine kurze Beschreibung zur Funktion vorhanden sein. Die Beschreibung soll die benötigten Eingabeparameter sowie etwaige Rückgabewerte erläutern. Außerdem sollte der Rückgabetyp ebenfalls bezeichnet werden.

Kurzum und in anderen Worten: Eine Funktionsübersicht ist wie eine Art zusammengefasste API-Dokumentation, welche du anderen Entwicklern bereitstellst.

Was konkret bei dir allerdings noch gefordert sein könnte und wie das auszusehen hat, solltest du mit deinen Betreuern / Lehrenden oder auch mit deinen Mitschülern bzw. Kommilitonen klären.

123Studi 15.07.2017, 02:52

ich danke dir erstmal für deine hilfreiche Antwort..Kann das als ein Flussdiagramm oder Organigramm dargestellt werden? 

0
LupusTerre 15.07.2017, 03:00
@123Studi

Das kann man bestimmt machen, wenn es erfordert wird. Ist aber für eine Funktionsübersicht nicht üblich, sondern gehört eher in eine ausführlichere Dokumentation.

Es soll ja kompakt und übersichtlich gehalten werden. Daher reicht eigentlich eine Auflistung der Funktionen nach oben beschriebenen Kriterien. Ganz plumpes Beispiel:

double mean(double a, double b)
Berechnet den Mittelwert zweier double Variablen a und b und gibt den Wert als double zurück.

double getA()
Gibt den Wert von Variable A als double zurück.

usw.

1
LupusTerre 15.07.2017, 03:04
@123Studi

Bitteschön ^^

Und hoppla: Um Missverständnisse zu vermeiden, solltest du den Rückgabetyp gesondert kenntlich machen. Sodass in der ersten Zeile jeweils wirklich nur steht, wie die Funktion aufgerufen werden muss. ^^

Kann das grade leider nicht mehr bearbeiten. Bin auch schon zu müde, um vorher mal dran gedacht zu haben. xD

0

Was möchtest Du wissen?