2016-05-31 14 views
3

Ich habe ein Python-Projekt, dass viele der Funktionen und Klassen Docstrings fehlen. Ich weiß, dass PyCharm automatisch Docstrings durch die Insert-Dokumentation String Stub Befehl mit Absicht Aktion hinzufügen kann. Für eine große Anzahl von Methoden und Funktionen ist es jedoch mühsam. Gibt es eine Methode zum Hinzufügen von Docstrings zu allen Funktionen auf einmal? dann fülle ich manuell was nötig ist.Ist es möglich, DocCheck-Strings an alle Funktionen in PyCharm anzuhängen?

Wenn nicht in PyCharm, Gibt es einen alternativen Client, der es tun kann?

Vielen Dank im Voraus für ...

Antwort

4

Schließlich hilft, fand ich eine Antwort, oder sie kann eine Abhilfe

In PyCharm,

  1. goto Datei \ Einstellungen \-Code Style \ Inspektionen sein Setzen Sie dann ein Häkchen vor "Fehlender oder leerer Docstring". Drücken Sie dann die OK-Taste.
  2. goto-Code \ Inspect-Code \ dann benutzerdefinierten Bereich auswählen >> Open Files
  3. Sie ein Panel unten mit Ihrem Projekt den Namen finden, dann Python \ Fehlende oder leer docstring \
  4. rechts auf den Titel klicken Sie auf „Fehlende oder empty docstring ", und wählen Sie den Befehl {Apply fix 'Fix docstring'}
  5. Das Programm wird automatisch zu allen Funktionen und Klassen Docsrtings hinzufügen.

Dies funktioniert für mich, Wenn jemand eine bessere Lösung oder Abhilfe haben, so wenden Sie sich bitte mit uns teilen. enter image description here