News - Features - Downloads - Forum - Team - Support - Switch View: Screen
Login - Registrierung - Passwort vergessen

Antworten: 10
Seite [1]
hajo ClanSphere Team


VIP - Poster




Herkunft: Barsbüttel
Beiträge: 9411
# Thema - 23.07.2010 um 00:04 Uhr
Der Inhalt von /system in dem sich der Kern von ClanSphere befindet ist jetzt in einer generierten Standard API Dokumentation verfügbar.

Es sind dafür keinerlei Anpassungen oder weitere Kommentare vorgenommen worden, allerdings sollte die Ansicht der Struktur auch so bereits helfen. Aufgrund des baldigen Wegfalls ist die xhtml_10_old.php nicht Bestandteil dieser Dokumentation.

Nützlich ist diese API Dokumentation sicherlich vor allem für Modul-Bastler und solche, die es einmal werden wollen.

Ihr findet den Inhalt hier:

http://csphere.eu/api


------------------
ClanSphere - professional clan care starts here
Inaktiv
mAnu


Try to beat me





Beiträge: 120
# Antwort: 1 - 23.07.2010 um 01:05 Uhr
wundervoll.. Auf sowas warte ich schon geschätzte 4 Jahre... ;-)


------------------


Inaktiv
|
ichraffsnicht ClanSphere Team

Supporter
Supporter



Herkunft: Erdeborn bei Lutherstadt Eisleben
Beiträge: 3191
# Antwort: 2 - 23.07.2010 um 08:26 Uhr
hajo du bistr so geil ich könnte dich fi**en^^


------------------



Inaktiv
|
bFeeee


Just nerd



Herkunft: Hamm
Beiträge: 944
# Antwort: 3 - 23.07.2010 um 11:17 Uhr
oha jetz gehts los


------------------
Grüße bFeee

Inaktiv
|
Tom08 ClanSphere Team

Supporter
Supporter



Herkunft: Daheim
Beiträge: 2923
# Antwort: 4 - 23.07.2010 um 12:37 Uhr
Super!
Das ist echt mal nützlich!



------------------
Bei Problemen mit Code von mir bitte eine Private Nachricht an mich


Inaktiv
|
fUnK3r ClanSphere Team


Specialist





Beiträge: 1656
# Antwort: 5 - 27.07.2010 um 00:43 Uhr
Sehr cool, um nicht zu sagen wunderschön


------------------
Grüßle Jo
><(((°> Son of God through Jesus Christ his Son <°)))><
www.funk3r.de
while (!asleep() ) sheep++;


Inaktiv
|
atonixx


Beginner




Beiträge: 1
# Antwort: 6 - 29.07.2010 um 09:51 Uhr
perfekt für den Einstieg in das CMS


Inaktiv
|
Godlike


King for a day




Herkunft: Offenbach
Beiträge: 230
# Antwort: 7 - 18.12.2010 um 15:34 Uhr
Wenn man trotz des alters dieses Freds noch was dazu sagen darf .

Hajo:
...allerdings sollte die Ansicht der Struktur auch so bereits helfen.

Ich muss aus Sicht eines Java Entwicklers sagen das du in gewissen masse recht hast, "ABER" mehr als einen Einblick und einen schnellen überblick über die Struktur erhält man nicht. Eine API-Dokumentation soll ja einem Endanwender eine Information darüber liefern, was er nun mit dieser oder jenen Funktion bewirken kann. Und da eure API, nichts für ungut, nicht die größte ist, ist die Dokumentation wie sie jetzt vorliegt, so gut wie unnütz.

Als beispiel:

Ich weiß nun das folgende Funktion existiert.
 
1.
2.
3.
1. / 2. / ... 
 cs_captcha (line 5)
void cs_captcha $hash)
 
$hash


Aber was genau sie macht sehe ich nur wenn ich in den Quelltext schaue. Gut man kann sagen ist ja nicht schlimm, ihr wollt aber auch das man eurer CMS erweitert und benutzt. Ich las sogar irgendwas von einem Coresphere. Nun ist es so, umso mehr Leute an etwas entwickeln umso wichtiger wird die Dokumentation aus eigenem Interesse und auch für andere.

Sie dient dazu um selbst geschriebenes später noch einmal zu verstehen und nachvollziehbar zu machen.
Sie dient anderen dazu, zu verstehen was der Programmierer mit dieser Klasse, Funktion oder Codeteil bewirken wollte.

Es geht ja dabei auch nicht um die Funktion selbst oder was sie macht. Es geht ja z.B. auch um die Rückgabewerte und deren Verhalten.

Naja ich hoffe ich konnte einen kleinen Denk anstoß geben
LG Goddy

PS: Sorry ich habe den PHP Code block zum Pasten der API Dokumentation missbraucht ^^.


------------------


Der schlimmste Fehler, den man im Leben machen kann, ist ständig zu befürchten, dass man einen macht.

Inaktiv
|
hajo ClanSphere Team
Thread-Ersteller


VIP - Poster




Herkunft: Barsbüttel
Beiträge: 9411
# Antwort: 8 - 18.12.2010 um 15:55 Uhr
bei coresphere sind die code bestandteile alle ausgiebig dokumentiert und entsprechend ist die erzeugte api doc dort auch ähnlich aussagekräftig wie die dir eventuell bekannte javadoc. bei clansphere wollte ich nur irgendwie zumindest mal eine übersicht aller vorhandenen bestandteile anbieten. das dies wenig bringt ist mir klar, aber es ist eben besser als garnichts.


------------------
ClanSphere - professional clan care starts here

Inaktiv
|
Asathor


Beginner





Beiträge: 10
# Antwort: 9 - 14.02.2013 um 16:37 Uhr
Alter Schwede, ich grab die ganze verdammte Suchfunktion mit Begriffen wie "cs_ übersicht" oder "funktions übersicht" umgegraben und finde nichts. Hättet ihr den Thread nicht etwas... Nap-Freundlicher nennen können?
Endlich kann ich los legen


Zuletzt editiert von Asathor am 14.02.2013 um 16:43 Uhr (1x Editiert)
Inaktiv
|
hajo ClanSphere Team
Thread-Ersteller


VIP - Poster




Herkunft: Barsbüttel
Beiträge: 9411
# Antwort: 10 - 14.02.2013 um 17:05 Uhr
thema ist doch angepinnt

ansonsten einfach neues thema öffnen und fragen, wer es nach 5 minuten suchen im forum usw. nicht findet darf das dann gern machen, auch wenn das eigentlich schon irgendwo steht.


------------------
ClanSphere - professional clan care starts here

Inaktiv
|
Antworten: 10
Seite [1]


Sie müssen sich registrieren, um zu antworten.


ClanSphere Project - Mailus - Imprint - Disclaimer - Scriptinfo