Πώς μπορώ να τεκμηριώσει μια ενότητα στην Python;

ψήφοι
44

Αυτό είναι. Αν θέλετε να τεκμηριώσει μια λειτουργία ή μια τάξη, να βάλετε μια σειρά αμέσως μετά τον ορισμό. Για παράδειγμα:

def foo():
    This function does nothing.
    pass

Αλλά τι γίνεται με την ενότητα; Πώς μπορώ να τεκμηριώσει τι file.py κάνει;

Δημοσιεύθηκε 04/09/2008 στις 17:06
πηγή χρήστη
Σε άλλες γλώσσες...                            


6 απαντήσεις

ψήφοι
4

Είναι εύκολο, απλά προσθέστε μια docstring στην κορυφή της μονάδας.

Απαντήθηκε 04/09/2008 στις 17:12
πηγή χρήστη

ψήφοι
38

Για τα πακέτα, μπορείτε να το τεκμηριώσετε στο __init__.py. Για τις ενότητες, μπορείτε να προσθέσετε ένα docstring απλά στο αρχείο της μονάδας.

Όλες οι πληροφορίες είναι εδώ: http://www.python.org/dev/peps/pep-0257/

Απαντήθηκε 04/09/2008 στις 17:12
πηγή χρήστη

ψήφοι
6

Μπορείτε να το ακριβώς με τον ίδιο τρόπο κάνουμε. Βάλτε ένα string ως την πρώτη δήλωση στη μονάδα.

Απαντήθηκε 04/09/2008 στις 17:12
πηγή χρήστη

ψήφοι
30

Προσθέστε docstring σας ως πρώτη δήλωση στη μονάδα .

Επειδή μου αρέσει να βλέπουμε ένα παράδειγμα:

"""
Your module's verbose yet thorough docstring.
"""

import foo

# ...
Απαντήθηκε 04/05/2014 στις 00:29
πηγή χρήστη

ψήφοι
5

Εδώ είναι ένα παράδειγμα της Google Style Python docstrings σχετικά με το πώς μπορεί να τεκμηριωθεί μονάδα. Βασικά υπάρχει μια πληροφορία σχετικά με μια μονάδα, πώς να το και πληροφορίες σχετικά με τις μεταβλητές επίπεδο μονάδας και τον κατάλογο των εκκρεμοτήτων στοιχεία εκτελέσει.

"""Example Google style docstrings.

This module demonstrates documentation as specified by the `Google
Python Style Guide`_. Docstrings may extend over multiple lines.
Sections are created with a section header and a colon followed by a
block of indented text.

Example:
    Examples can be given using either the ``Example`` or ``Examples``
    sections. Sections support any reStructuredText formatting, including
    literal blocks::

        $ python example_google.py

Section breaks are created by resuming unindented text. Section breaks
are also implicitly created anytime a new section starts.

Attributes:
    module_level_variable1 (int): Module level variables may be documented in
        either the ``Attributes`` section of the module docstring, or in an
        inline docstring immediately following the variable.

        Either form is acceptable, but the two should not be mixed. Choose
        one convention to document module level variables and be consistent
        with it.

Todo:
    * For module TODOs
    * You have to also use ``sphinx.ext.todo`` extension

.. _Google Python Style Guide:   
http://google.github.io/styleguide/pyguide.html

"""

module_level_variable1 = 12345

def my_function():   
    pass 
... 
...
Απαντήθηκε 28/01/2017 στις 19:34
πηγή χρήστη

ψήφοι
0

Για PyPI Πακέτα:

Αν προσθέσετε χορδές έγγραφο όπως αυτό που σου __init__.py αρχείο όπως φαίνεται παρακάτω

"""
Please refer to the documentation provided in the README.md,
which can be found at gorpyter's PyPI URL: https://pypi.org/project/gorpyter/
"""

# <IMPORT_DEPENDENCIES>

def setup():
    """Verify your Python and R dependencies."""

Στη συνέχεια, θα λάβετε αυτό στην καθημερινή χρήση της λειτουργίας βοήθεια.

help(<YOUR_PACKAGE>)

DESCRIPTION
    Please refer to the documentation provided in the README.md,
    which can be found at gorpyter's PyPI URL: https://pypi.org/project/gorpyter/

PACKAGE CONTENTS


FUNCTIONS
    connect(project, api_key)
        Authenticate with your WXNC instance gateway.

    query(query, conn)
        Run a GOR query.

    setup()
        Verify your Python and R dependencies.

Σημειώνεται, ότι η βοήθειά μου DESCRIPTIONπροκαλείται από την κατοχή ότι η πρώτη docstring στην κορυφή του αρχείου.

Απαντήθηκε 16/08/2019 στις 21:54
πηγή χρήστη

Cookies help us deliver our services. By using our services, you agree to our use of cookies. Learn more