Dokumentasi & pengujian dalam praktik

Prinsip Rekayasa Perangkat Lunak di Python

Adam Spannbauer

Machine Learning Engineer at Eastman

Mendokumentasikan proyek dengan Sphinx

  Contoh Halaman Sphinx

Prinsip Rekayasa Perangkat Lunak di Python

Mendokumentasikan kelas

class Document:
    """Menganalisis data teks

    :param text: teks untuk dianalisis

    :ivar text: teks yang awalnya diberikan ke instance saat pembuatan
    :ivar tokens: Daftar kata yang diurai dari teks
    :ivar word_counts: Counter yang berisi jumlah hashtag yang digunakan dalam teks
    """
    def __init__(self, text):
        ...
Prinsip Rekayasa Perangkat Lunak di Python

Pengujian integrasi berkelanjutan

    Logo Travis CI

Contoh Output Travis - Gagal

Prinsip Rekayasa Perangkat Lunak di Python

Pengujian integrasi berkelanjutan

  Contoh Output Travis - Berhasil

Prinsip Rekayasa Perangkat Lunak di Python

Tautan dan alat tambahan

  • Sphinx - Hasilkan dokumentasi yang indah
  • Travis CI - Uji kode Anda secara berkelanjutan
  • GitHub & GitLab - Hosting proyek Anda dengan git
  • Codecov - Temukan area untuk meningkatkan pengujian proyek Anda
  • Code Climate - Analisis kode Anda untuk perbaikan keterbacaan
Prinsip Rekayasa Perangkat Lunak di Python

Mari Berlatih

Prinsip Rekayasa Perangkat Lunak di Python

Preparing Video For Download...