08. Comment dan catatan untuk dirimu sendiri — Solusi pekerjaan rumah

File solusi .py ada di exercises/08/homework/solutions/.

Soal 1 — Beri anotasi pada program

Soal. Tambahkan header dan dua comment mengapa tanpa mengubah output.

Cara memikirkannya. Comment tidak pernah mempengaruhi output, jadi ini murni komunikasi. Header menjelaskan apa yang dilakukan file; comment inline menjelaskan pilihan yang mungkin dipertanyakan pembaca.

Solusi yang dikerjakan.

"""
Prints a tiny scoreboard line for one player.
Used to check the score formula by eye.
"""

base = 50        # everyone starts the round with 50
bonus = 25       # reward for a no-damage run
print("Score: " + str(base + bonus))

Kesalahan umum.

  • # add base and bonus di atas baris print hanya mengulangnya. Jelaskan mengapa 25 adalah bonusnya, bukan bahwa itu ditambahkan.

Soal 2 — Temukan bug dengan mengkomentari

Soal. Matikan satu baris sehingga outputnya adalah start lalu end.

Solusi yang dikerjakan.

print("start")
# print("this line should not be here")
print("end")

Kesalahan umum.

  • Menghapus baris daripada mengkomentarinya. Mengkomentari mempertahankannya kalau kamu ingin memakainya kembali.

Soal 3 — Matikan sebuah blok

Soal. Gunakan satu blok """ untuk mematikan tiga baris di tengah.

Solusi yang dikerjakan.

print("first")
"""
print("middle 1")
print("middle 2")
print("middle 3")
"""
print("last")

Output:

first
last

Kesalahan umum.

  • Lupa penutup """, yang mematikan sisa file termasuk print("last").

Tantangan — Mengapa, bukan apa

Soal. Ganti comment yang mengulang kode dengan comment yang berguna.

Cara memikirkannya. Untuk setiap baris, tanya "apakah pembaca sudah tahu ini dari kode?" Kalau iya, comment itu adalah kebisingan — hapus atau berikan alasannya sebagai gantinya.

Solusi yang dikerjakan. Sebelum:

lives = 3      # set lives to 3
lives = lives - 1    # subtract 1 from lives

Sesudah:

lives = 3      # standard start; three tries per game
lives = lives - 1    # player walked into the lava

Kesalahan umum.

  • Memperbarui kata-kata setiap comment tanpa memotong. Terkadang comment terbaik adalah tidak ada — kalau kode sudah jelas, diam itu baik.

Selesai?

Kamu sekarang bisa meninggalkan catatan yang membantu, bukan mengacaukan, dan mematikan kode tanpa menghapusnya. Selanjutnya adalah Toolkit print, lebih dalam tentang menampilkan hal-hal di layar.