[PYTHON] Comment écrire des commentaires pydoc et multi-lignes

20161209

Python 3 jours d'utilisation nette de Perl

Conclusion sur les commentaires habituels

À l'exception de l'alternative au document d'audience, «» »« n'existe que pour «pydoc», et tous les autres commentaires doivent être écrits en «#» [^ 1].

[^ 1]: La source de pydoc elle-même est écrite de cette façon ... À tout le moins, j'aimerais pouvoir spécifier = begin, = end, = cut of perl ...

code

--Confirmé dans 2.6, 2.7, 3.4 --Dans un sens tactique, il ne considère pas si l'imbrication de fonction ou la classe dans si le bloc est possible.

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'

Résultat d'exécution

--ʻU '...' `est inutile => la série 2.6 est de la mousse. [^ 2]

[^ 2]: série 2.6 Si vous n'avez pas à y penser, vous devriez l'ajouter. [^ 3]: Mon futur moi

$ 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

Comment écrire des commentaires pydoc et multi-lignes
Comment écrire des commentaires de document Python (Docstrings)
XPath Basics (2) - Comment écrire XPath
Comment écrire une classe méta qui prend en charge à la fois python2 et python3
[ROS] Comment écrire un éditeur et un abonné sur un nœud
Comment écrire sobrement avec des pandas
Réutilisation du flacon Comment écrire du HTML
Comment installer et configurer Blackbird
Comment utiliser .bash_profile et .bashrc
Comment installer et utiliser Graphviz
Comment écrire une image de base Docker
Comment écrire un fichier wsgi.py indépendant de l'environnement Django1.9
Remarques sur la rédaction de requirements.txt
Résoudre des puzzles et 15 puzzles
Comment écrire un exemple d'implémentation E11 Ruby et Python en temps réel hors ligne
Repeated @ app.callback dans Dash Comment écrire correctement l'entrée et l'état
[Linux] Comment subdiviser des fichiers et des dossiers
Comment diviser et enregistrer un DataFrame
Qiita (1) Comment écrire un nom de code
Comment lire pydoc sur l'interpréteur python
Comment définir optuna (comment écrire un espace de recherche)
Comment installer et utiliser pandas_datareader [Python]
Lier à la classe pour lire et écrire YAML
python: Comment utiliser les locals () et globals ()
Divers commentaires à écrire dans le programme
[Python] Comment calculer MAE et RMSE
Comment utiliser le zip Python et énumérer
Compressez les données python et écrivez sur sqlite
Comment écrire ce processus en Perl?
Comment utiliser is et == en Python
Comment écrire Ruby to_s en Python
Résumé de l'écriture d'AWS Lambda
Comment utiliser les pandas Timestamp et date_range
Comment installer le tissu et comment l'utiliser
Comment écrire le bon shebang dans les scripts Perl, Python et Ruby
Comment écrire un test unitaire pour l'extraction d'URL dans GAE / P
Introduction du cadre de style Sinatra et comment l'utiliser
Comment générer une séquence en Python et C ++
Comment créer des variables explicatives et des fonctions objectives
Réponse à "Comment écrire le problème F02 en temps réel hors ligne"
[Python] Comment lire les données de CIFAR-10 et CIFAR-100
Récupération des données de MacNote3 et migration vers Write
Comment écrire une instruction ShellScript Bash for
Réponse à "Comment écrire un problème F01 en temps réel hors ligne"
Comment basculer entre les shells Linux et Mac
[Python] Comment utiliser la fonction de hachage et taple.
Réponse au "Problème d'écriture en temps réel hors ligne E13"
Comment écrire un document tuple nommé en 2020
[Go] Comment écrire ou appeler une fonction
Comment installer le détecteur Cascade et comment l'utiliser
Comment écrire une instruction de cas bash ShellScript
Comment tracer l'autocorrélation et l'autocorrélation partielle avec Python
[Python] [Django] Comment utiliser le champ de choix et comment ajouter des options
Comment écrire une interface graphique à l'aide de la commande maya