Nasıl Python bir modül belgelemek mı?

oy
44

Bu kadar. Eğer bir işlev veya bir sınıf belgelemek istiyorsanız, sadece tanımından sonra bir dize koydu. Örneğin:

def foo():
    This function does nothing.
    pass

Ama bir modül ne olacak? Nasıl bir şey belgelenebilir file.py yapar?

Oluştur 04/09/2008 saat 15:06
kaynak kullanıcı
Diğer dillerde...                            


6 cevaplar

oy
4

Çok kolay, sadece modülün üst kısmında bir docstring'ini ekleyin.

Cevap 04/09/2008 saat 15:12
kaynak kullanıcı

oy
38

Paketler için, bunu içinde belge olabilir __init__.py. Modüllerin için, sadece modül dosyasında bir docstring'ini ekleyebilir.

Tüm bilgiler burada: http://www.python.org/dev/peps/pep-0257/

Cevap 04/09/2008 saat 15:12
kaynak kullanıcı

oy
6

Bunu aynen böyle yapmak. modülünde ilk ifadesi olarak bir dize koyun.

Cevap 04/09/2008 saat 15:12
kaynak kullanıcı

oy
30

Olarak docstring'ini ekle modülünde ilk açıklamada .

Bir örnek görmek gibi yana:

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

import foo

# ...
Cevap 03/05/2014 saat 22:29
kaynak kullanıcı

oy
5

İşte bir olan Örnek tarihinde Stil Python Docstringler modülü belgelenmiş alınabileceği konusunda. Temelde o ve modül düzeyi değişkenleri ve Yapılacaklar öğeleri listesi hakkında bilgi çalıştırmak için nasıl bir modül, yaklaşık bir bilgi yoktur.

"""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 
... 
...
Cevap 28/01/2017 saat 17:34
kaynak kullanıcı

oy
0

PyPI Paketleri İçin:

Eğer böyle doc dizeleri eklerseniz __init__.py dosyası aşağıda görüldüğü gibi

"""
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."""

Sonra yardım fonksiyonunun günlük kullanımda bu alacaktır.

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.

Benim yardım Unutmayın, DESCRIPTIONdosyanın en üstünde ilk docstring'ini alarak tetiklenir.

Cevap 16/08/2019 saat 20:54
kaynak kullanıcı

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