Dokumentasi Program pada Python

Dokumentasi, sering kali hal yang terlupakan. Programmer rata-rata, serasa berat melakukan pekerjaan ini. Yang sebetulnya, hal ini penting, karena membantu kita bila harus melakukan maintenance.

Bayangkan, program dibuat 10 tahun yang lalu, terus gak ada dokumentasinya. Bisa pedih mata kita bacain program satu-persatu.

Python menggunakan docstring untuk melakukan dokumentasi. Yaitu blok string dalam triple quote

"""
Docstring goes here
"""

Dokumentasi tentang modul secara umum disimpan diawal program. Untuk dokumentasi fungsi, tuliskan blok dokumentasi diawal blok setelah deklarasi fungsi.

Untuk lebih jelas, silakan lihat kode berikut.

"""Tetrieve and print word from URL.

Usage:
    python pyfund.py 
"""
import sys
from urllib.request import urlopen


def fetch_word(url):
    """Fetch a list of words from URL.

    Args:
        url: The URL of a UTF-8 text document.

    Returns:
        A list of strings containing the words from
        the document.
    """
    with urlopen(url) as story:
        story_words = []
        for line in story:
            line_words = line.decode('utf-8').split()
            for words in line_words:
                story_words.append(words)
    return story_words


def print_items(items):
    """Print items one per line

    Args:
        An iterable series of printable items.
    """
    for item in items:
        print(item)


def main(url):
    """Print each word from a text document from a URL.

    Args:
        url: The URL of a UTF-8 text document.
    """
    words = fetch_word(url)
    print_items(words)


if __name__ == '__main__':
    main(sys.argv[1])