Dokumentasi

Prinsip Rekayasa Perangkat Lunak di Python

Adam Spannbauer

Machine Learning Engineer at Eastman

Dokumentasi di Python

Komentar

# Mengkuadratkan angka x

Docstring

    """Mengkuadratkan angka x

    :param x: angka yang akan dikuadratkan
    :return: x dikuadratkan

    >>> square(2)
    4
    """

Komentar

# Ini adalah komentar yang valid
x = 2

y = 3  # Ini juga komentar yang valid

# Anda tidak dapat melihat saya kecuali Anda melihat kode sumber

# Hai kolaborator masa depan!!

Komentar efektif

Komentar 'apa'

# Definisikan people sebagai 5
people = 5

# Kalikan people dengan 3
people * 3

Komentar 'mengapa'

# Akan ada 5 orang yang menghadiri pesta
people = 5

# Kita butuh 3 potong pizza per orang
people * 3

Docstring

def function(x):
    """Deskripsi tingkat tinggi dari fungsi

    Detail tambahan tentang fungsi

Docstring

def function(x):
    """Deskripsi tingkat tinggi dari fungsi

    Detail tambahan tentang fungsi

    :param x: deskripsi parameter x
    :return: deskripsi nilai kembalian

Halaman web contoh yang dihasilkan dari docstring dalam paket Flask.

Docstring

def function(x):
    """Deskripsi tingkat tinggi dari fungsi

    Detail tambahan tentang fungsi

    :param x: deskripsi parameter x
    :return: deskripsi nilai kembalian

    >>> # Contoh penggunaan fungsi
    Hasil yang diharapkan dari penggunaan fungsi contoh
    """
    # kode fungsi

Contoh docstring

def square(x):
    """Mengkuadratkan angka x

    :param x: angka yang akan dikuadratkan
    :return: x dikuadratkan

    >>> square(2)
    4
    """
    # `x * x` lebih cepat daripada `x ** 2`
    # referensi: https://stackoverflow.com/a/29055266/5731525
    return x * x

Output contoh docstring

help(square)

square(x)
    Mengkuadratkan angka x

    :param x: angka yang akan dikuadratkan
    :return: x dikuadratkan

    >>> square(2)
    4

Mari Berlatih

Prinsip Rekayasa Perangkat Lunak di Python