Wie entscheiden Sie, Dokumentationen, welche API-Funktion zu lesen und wie ernst? [geschlossen]

Question

Nehmen wir an, Sie schreiben, oder ein Stück Code beibehalten wird, die einige API verwendet, die Sie nicht 100% vertraut sind.

Wie entscheiden Sie, ob Sie die Dokumentation eines bestimmten Anrufziel zu lesen, und wie viel Zeit sie zu lesen verbringen? Wie entscheiden Sie, es nicht zu lesen?

(Lassen Sie uns annehmen, dass Sie es durch Öffnen der HTML-Dokumentation lesen können, den Quellcode Inspektion oder mit dem Hover-Mechanismus in der IDE).

Answer 1

Im Idealfall sollten Sie lesen alle davon, aber wir wissen, das ist ein Schmerz in der ... Sie wissen. Was ich auf diesen Fällen normalerweise tun (und ich habe das viel, während ich als Freelancer gearbeitet) Gewicht einige Faktoren ist und je nach Ergebnis, las ich die Dokumentation.

Faktoren, die mir sagen, ich soll nicht die Dokumentation lesen:

• Was die Funktion tut, ist einfach aus dem Namen zu erraten.
• Es ist auf den Code nicht relevant Ich bin Aufrechterhaltung: zum Beispiel, Sie überprüfen, wie einige Code-Dateien löscht, und Sie haben eine Funktion, die einige UI-Update offensichtlich der Fall ist. Sie kümmern sich nicht um das für jetzt.
• Wenn das Debuggen: die Funktion sinnvoll in einer Weise, bei der Hand, um die Aufgabe nicht den Programmzustand verändern. Nach wie vor, Sie wollen nicht lernen, was SetOverlayIcon der Fall ist, wenn Sie den Lösch Code debuggen, weil es mit einem Dateisystemfehler sterben.
• Die API ist nur ein Spezialfall einer API Sie bereits kennen und Sie können erraten, was der Sonderfall ist, und dem, was die besonderen Argumente (falls vorhanden) zu tun. Zum Beispiel, sagen wir, Sie WriteToFile (string filename) und WriteToFile (string filename, boolean überschreiben) haben.

Natürlich alles hängt vom Kontext ab, so dass auch diese Regeln haben Ausnahmen.