1
Dies ist ein einfacher Filter, den ich für ein Projekt verwendet habe, das Daten über eine serielle Verbindung liest, und dachte, es wäre gut, ihn als meinen ersten Versuch zu benutzen, Docstrings zu schreiben. Hat jemand irgendwelche Vorschläge? Ich habe PEP 257 gelesen. Wie es eine Klasse ist, sollten die Schlüsselwortargumente nach __init__ kommen?Wie würde ich diese einfache Python-Klasse und ihren Docstring verbessern?
Wenn es einen besseren Weg gibt, einen Teil davon zu schreiben (nicht nur die Docstrings), würde ich mich freuen, wenn die Leute mich in die richtige Richtung weisen könnten.
http://codereview.stackexchange.com/?as=1 ist wahrscheinlich ein besserer Ort für diese Frage, aber ich habe eine Menge von meinem Stil auf [google Python Style Guide] (http: // google-styleguide. googlecode.com/svn/trunk/pyguide.html?showone=Comments#Comments), dem Ihr Docstring ziemlich gut entspricht. Es ist schwierig, die Dokumentation für solch einen einfachen Fall auszuwerten: Ich bin sehr dankbar für die Dokumentation, wenn es die Verwendung einer komplexen Funktion oder Klasse vereinfacht. –
Ich verstehe es völlig. Ich dachte, ein einfaches Beispiel würde es den Leuten leichter machen, schnell zu lesen, anstatt sich in dem, was es tatsächlich getan hat, zu verirren und somit nicht in der Lage zu kommentieren, da sie nicht wussten, was der Code tatsächlich tat. – beoliver
Haben Sie überlegt, Kritik an Ihrer Oberfläche und Ihrer Dokumentation zu bekommen? –