Wie mit einer undokumentierten API / Framework-unter .NET umgehen? [geschlossen]

Question

Für die Arbeit hat mich mit einer externen Unternehmens-API Code mit ihrer proprietären Datenbanklösung zu behandeln. Leider ist die Dokumentation bieten sie eher ein Beispiel Führung dann die richtige API-Dokumentation, so ist es sehr leicht auf Nitty Gritty Details wie Fehlercodes, Methode zurückgibt, und Ausnahmen.

So zum Beispiel wird eine Klasse einen .GetErrorCode () -Methode, aber ich habe keine Ahnung, was diese Fehlernummern bedeuten, weil sie nicht dokumentieren, welche Nummer übereinstimmt mit dem, was Fehler. In vielen Fällen ist eine Methode ein Objekt zurückgeben, ohne Dokumentation dessen, was die Art von Objekt tatsächlich gibt es zurück. Ich habe sie immer wieder für die richtige Dokumentation gefragt, aber sie scheinen Details zu denken, wie die oben genannten haben Anstand Geheimnisse sind. So ist es Tools oder Methoden, die ich um meinen begrenzten oder in einigen Fällen nicht vorhandene Dokumentation arbeiten kann.

Bitte beachten Sie, dass ich von Visual Studo 2005 und Codierung in C # unter .NET verwenden.

Und bevor jemand antwortet: „nicht über die API verwenden“, muss ich es für die Arbeit ist.

Answer 1

Eine böse Szenario. Ich hasse es vorschlagen, aber vielleicht Reflektor Ihr Freund ist, wenn es nicht verschleiert wird . Es kann einige Fragen des geistigen Eigentums sein, aber in diesem Fall Umkehr scheint die einzig gangbare Weg, um herauszufinden, was die API ist. Allerdings vermute ich (von Methoden wie .GetErrorCode ()), dass dies ein Shim auf der P / Invoke ist - in diesem Fall sogar Reflektor wird Ihnen zeigen viele externe Anrufe ...

Das Haupt andere Sache, kann ich nur sagen: schreiben Partien von Unit-Tests, die decken, wie Sie versuchen, es zu benutzen ... auf diese Weise, wenn Sie falsch raten und sich etwas ändert, Sie wissen werden, früh.

Answer 2

Wenn ich nicht Codebeispiele erhalten oder zu einem ursprünglichen Entwickler sprechen, ich greifen in der Regel auf Reflector an dem zugrunde liegenden Code zu suchen. Es ist langsam und ineffizient, aber manchmal ist das alles, was Sie tun können.

Answer 3

Es hängt von Ihrer Situation. Wenn Sie die API zahlen sind, sollten Sie das Unternehmen weiterhin für eine bessere Dokumentation der auf Druck, wie die API verwenden.

Wenn das nicht funktioniert, was ich tun würde, ist meine eigene Dokumentation beginnen, wie ich entwickeln. Halten Sie ein Notebook, ein persönliches Wiki ( ScrewTurn Wiki den Sinn kommt), oder irgendeine Art von elektronischen Dokumentation. Wie einige andere Leute erwähnt, können Sie Reflector verwenden, um an die Quelle (wenn es nicht verschleiert wird).

Erstellen einer eigenen Dokumentation kann nicht sein, was Sie suchen, aber wenn Sie nicht wirklich Dokumentation bekommen, zumindest einen Teil erstellen, wie Sie Dinge, so dass Sie etwas haben, können Sie ein paar Monate (oder Jahre) zu führen auf der Straße, wenn Sie versuchen, den Code mit der API gebaut zu halten.

Answer 4

Die besten Tools, die den Sinn kommen, sind Telefon und E-Mail. Hoffentlich können Sie Leute dort halten nerven, bis sie Ihnen weitere nützliche Informationen geben ...: (

Answer 5

Verwenden Sie Reflector den Quellcode zu sehen. Sollte zeigen Ihnen die Enum für die getErrorCode Nachricht.

Reflektor, nebenbei bemerkt, ist das größte Programm in der Geschichte des Universums.