Lesson Membuat dokumentasi program python akan membahas inline dokumentasi pada program.
Kebanyakan programmer enggan melakukan pekerjaan dokumentasi. padahal dokumentasi itu penting, akan membantu saat maintenance atau bila ada perubahan.
Contoh ekstrim, program dibuat 10 tahun yang lalu, tidak terdokumentasi. Bisa dibayangkan kita harus membaca program baris per baris untuk memahami maksud dan tujuan dari sebuah fungsi atau modul.
Dokumentasi di Python cukup mudah, menggunakan docstring, 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.
Berdasarkan contoh docstring dibawah, kita paham, bahwa modul digunakan untuk mengambil kata dari sebuah URL kemudian melakukan fungsi print ke screen. Cara penggunaanya adalah dengan memanggil python pyfund.py
"""Retrieve 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])
Pembahasan Code
Dalam modul, terdapa fungsi fetch_word(url), dari docstring, dapat kita ketahui fungsi ini berguna mengambil kata dari sebuah URL.
Argument dari fungsi adalah URL, dan return dari fungsi adalah list of string dari document yang ditunjukan URL.
Dan seterusnya, untuk fungsi-fungsi berikutnya. Jadi cukup mudah untuk membuat dokumentasi pada program Python.