[PYTHON] Wie schreibe ich pydoc und mehrzeilige Kommentare

20161209

Python 3 Tage Netto-Nutzung von Perl

Fazit zu üblichen Kommentaren

Mit Ausnahme der Alternative zum Anhörungsdokument existiert "" nur für "pydoc", und alle anderen Kommentare sollten in "#" [^ 1] geschrieben werden.

[^ 1]: Die Quelle von pydoc selbst ist so geschrieben ... Zumindest wünschte ich, ich könnte = begin, = end, = cut von perl angeben ...

Code

foo.py


#!/usr/bin/env python
# -*- encoding: utf-8 -*-
'''
about NAME

DESCRIPTION
'''

__author__  = 'bunzaemon'
__version__ = '1.0'
__date__    = '2016/12/09'

x = 42
print (x)
'IGNORED comment'

def foo ():
    # of course ignored
    'DEF: foo'
    'IGNORED comment'
    def bar ():
        'DEF: bar <= IGNORED'

class Clas:
    'CLASS: Clas'
    def __init__ (self):
        'CLASS DEF: __init__'

if 1:
    'IGNORED comment'
    y = 42
    print (y)
    def buz ():
        'DEF: buz'
        def bux ():
            'IGNORED comment'
    class Clas2:
        'CLASS: Clas2'

if 0:
    z = 42
    print (z)
    class Clas3:
        'IGNORED comment'

Ausführungsergebnis

--u '...'ist nutzlos => 2.6 Serie ist Moos. [^ 2]

[^ 2]: 2.6 Serie Wenn Sie nicht darüber nachdenken müssen, sollten Sie es hinzufügen. [^ 3]: Mein zukünftiges Ich

$ python --version
Python 2.6.6
$ python ./foo.py
42
42
$ pydoc ./foo.py
Help on module foo:

NAME
    foo - about NAME

FILE
    /PATH/TO/foo.py

DESCRIPTION
    DESCRIPTION

CLASSES
    Clas
    Clas2

    class Clas
     |  CLASS: Clas
     |
     |  Methods defined here:
     |
     |  __init__(self)
     |      CLASS DEF: __init__

    class Clas2
     |  CLASS: Clas2

FUNCTIONS
    buz()
        DEF: buz

    foo()
        DEF: foo

DATA
    __author__ = 'bunzaemon'
    __date__ = '2016/12/09'
    __version__ = '1.0'
    x = 42
    y = 42

VERSION
    1.0

DATE
    2016/12/09

AUTHOR
    bunzaemon

Recommended Posts

Wie schreibe ich pydoc und mehrzeilige Kommentare
So schreiben Sie Python-Dokumentkommentare (Docstrings)
XPath-Grundlagen (2) - So schreiben Sie XPath
So schreiben Sie eine Meta-Klasse, die sowohl Python2 als auch Python3 unterstützt
[ROS] So schreiben Sie Publisher und Subscriber auf einen Knoten
Wie man nüchtern mit Pandas schreibt
Wiederverwendung von Flaschen Wie schreibe ich HTML?
So installieren und konfigurieren Sie Amsel
Verwendung von .bash_profile und .bashrc
So installieren und verwenden Sie Graphviz
So schreiben Sie ein Docker-Basis-Image
Wie schreibe ich Django1.9 umweltunabhängig wsgi.py
Hinweise zum Schreiben von require.txt
Lösen von Folienrätseln und 15 Rätseln
Offline in Echtzeit, wie man ein Implementierungsbeispiel für E11 Ruby und Python schreibt
Repeated @ app.callback in Dash So schreiben Sie Input und State ordentlich
[Linux] Unterteilen von Dateien und Ordnern
So teilen und speichern Sie einen DataFrame
Qiita (1) Wie schreibe ich einen Codenamen?
Wie man pydoc auf Python Interpreter liest
Wie man optuna einstellt (wie man einen Suchraum schreibt)
So installieren und verwenden Sie pandas_datareader [Python]
Binden Sie an die Klasse, um YAML zu lesen und zu schreiben
Python: Verwendung von Einheimischen () und Globalen ()
Verschiedene Kommentare im Programm zu schreiben
[Python] Berechnen von MAE und RMSE
Verwendung von Python zip und Aufzählung
Komprimieren Sie Python-Daten und schreiben Sie in SQLite
Wie schreibe ich diesen Prozess in Perl?
Verwendung ist und == in Python
Wie schreibe ich Ruby to_s in Python
Zusammenfassung des Schreibens von AWS Lambda
Verwendung von pandas Timestamp und date_range
Wie man Fabric installiert und wie man es benutzt
So schreiben Sie den richtigen Shebang in Perl-, Python- und Ruby-Skripten
So schreiben Sie einen Komponententest für den URL-Abruf in GAE / P.
Einführung des Sinatra-Frameworks und dessen Verwendung
So generieren Sie eine Sequenz in Python und C ++
So erstellen Sie erklärende Variablen und Zielfunktionen
Antwort auf "Offline in Echtzeit, wie man ein F02-Problem schreibt"
[Python] Lesen von Daten aus CIFAR-10 und CIFAR-100
Abrufen von Daten von MacNote3 und Migrieren zu Write
So schreiben Sie einen ShellScript Bash für Anweisung
Antwort auf "Offline-Echtzeit, wie man ein F01-Problem schreibt"
So wechseln Sie zwischen Linux- und Mac-Shells
[Python] Verwendung von Hash-Funktion und Taple.
Antwort auf "Offline-Echtzeit, wie man ein E13-Problem schreibt"
Wie schreibe ich ein benanntes Tupeldokument im Jahr 2020?
[Go] So schreiben oder rufen Sie eine Funktion auf
So installieren Sie den Cascade-Detektor und wie verwenden Sie ihn
So schreiben Sie eine ShellScript-Bash-Case-Anweisung
Wie man Autokorrelation und partielle Autokorrelation mit Python zeichnet
[Python] [Django] Verwendung des Auswahlfelds und Hinzufügen von Optionen
So schreiben Sie eine GUI mit dem Befehl maya