Menulis Kode Bersih

Kode yang bersih adalah ciri khas pengembang yang terampil. Meskipun praktik pengkodean seperti mengikuti panduan gaya, menggunakan nama yang bermakna, dan menulis kode KERING sudah dikenal luas, ada cara lain yang tidak terlalu jelas untuk meningkatkan kualitas kode Anda. kode. Pada artikel ini, kita akan mengeksplorasi beberapa tip tidak biasa untuk menulis kode bersih yang dapat dimanfaatkan oleh semua pengembang.

Rangkullah Kekuatan Kendala

Membatasi diri Anda pada seperangkat alat atau kerangka kerja tertentu dapat membantu Anda menjadi lebih kreatif dalam memecahkan masalah. Batasan dapat menyederhanakan kode Anda dan mempermudah pemeliharaannya. Misalnya, batasi diri Anda untuk hanya menggunakan perpustakaan standar untuk sebuah proyek, atau tantang diri Anda untuk menulis solusi dalam jumlah baris tertentu. Dengan melakukan ini, Anda akan belajar untuk fokus pada hal-hal penting dan pada akhirnya membuat kode yang lebih bersih dan efisien.

Lihat contoh di bawah ini:

# Using only standard libraries
import random

def generate_random_numbers(limit, count):
    return [random.randint(1, limit) for _ in range(count)]

print(generate_random_numbers(100, 5))

Perlakukan Kode Anda Seperti Sebuah Cerita

Setiap bagian kode memiliki cerita untuk diceritakan. Dengan memperlakukan kode Anda sebagai sebuah narasi, Anda dapat lebih memahami alur dan strukturnya. Mulailah dengan membuat garis besar cerita kode Anda, dan gunakan komentar untuk menjelaskan “plot” dan “karakter”. Pendekatan ini akan membantu Anda dan rekan satu tim Anda memvisualisasikan tujuan kode dan mempermudah pemeliharaan dan pemfaktoran ulang.

# The story of a function that checks if a number is prime

def is_prime(number):
    """Check if a given number is prime."""
    if number <= 1:
        return False
    for i in range(2, number):
        # The 'antagonist': a divisor that proves the number is not prime
        if number % i == 0:
            return False
    # The 'resolution': the number is prime
    return True

print(is_prime(5))

Kuasai Seni Abstraksi

Abstraksi adalah proses menyederhanakan sistem yang kompleks dengan memecahnya menjadi komponen-komponen yang lebih kecil dan lebih mudah dikelola. Menguasai seni ini dapat menghasilkan kode yang lebih bersih dan modular. Untuk mempraktikkan abstraksi, cobalah memecah masalah yang kompleks menjadi bagian-bagian yang lebih kecil, lalu buat fungsi atau kelas untuk menangani setiap bagian. Hal ini akan membantu Anda menjaga pemisahan masalah yang jelas, membuat kode Anda lebih mudah dipahami dan dipelihara.

# Example of abstraction with classes
class Animal:
    def speak(self):
        raise NotImplementedError()

class Dog(Animal):
    def speak(self):
        return "Woof!"

class Cat(Animal):
    def speak(self):
        return "Meow!"

animals = [Dog(), Cat()]

for animal in animals:
    print(animal.speak())

Merangkul Pengembangan Berbasis Tes (TDD)

Pengembangan berbasis pengujian (TDD) adalah pendekatan pengembangan perangkat lunak di mana Anda menulis pengujian untuk kode Anda sebelum menulis kode itu sendiri. Dengan mengadopsi TDD, Anda dapat memastikan bahwa kode Anda bersih, terstruktur dengan baik, dan berfungsi sesuai tujuannya. Mulailah dengan menulis tes untuk fungsi tertentu, lalu tulis kode untuk lulus tes tersebut. Ini akan membantu Anda fokus menulis kode yang diperlukan saja dan menghindari rekayasa berlebihan.

import unittest

def add(a, b):
    return a + b

class TestAddition(unittest.TestCase):
    def test_addition(self):
        self.assertEqual(add(1, 2), 3)
        self.assertEqual(add(-1, 1), 0)
        self.assertEqual(add(0, 0), 0)

if __name__ == '__main__':
    unittest.main()

Renungkan Kode Anda Secara Teratur

Mengevaluasi dan merefleksikan kode Anda secara terus-menerus dapat menghasilkan peningkatan yang signifikan seiring berjalannya waktu. Luangkan waktu untuk meninjau pekerjaan Anda, dan identifikasi area yang dapat ditingkatkan atau disederhanakan. Gunakan ini sebagai kesempatan untuk belajar dari kesalahan Anda dan menyempurnakan keterampilan coding Anda.

# Initial implementation
def old_sum_of_squares(numbers):
    result = 0
    for number in numbers:
        square = number * number
        result += square
    return result

# After reflection and optimization
def new_sum_of_squares(numbers):
    return sum(number * number for number in numbers)

print(old_sum_of_squares([1, 2, 3, 4]))
print(new_sum_of_squares([1, 2, 3, 4]))

Kesimpulan

Menulis kode yang bersih adalah perjalanan berkelanjutan yang membutuhkan pembelajaran dan peningkatan terus-menerus. Dengan menerima batasan, memperlakukan kode Anda seperti sebuah cerita, menguasai abstraksi, mengadopsi TDD, dan merefleksikan pekerjaan Anda, Anda dapat meningkatkan keterampilan coding Anda ke tingkat yang lebih tinggi. Ingat, kode yang bersih bukan hanya tentang membuat kode Anda terlihat cantik — ini tentang membuatnya lebih efisien, mudah dipelihara, dan lebih mudah dipahami oleh Anda dan sesama pengembang.

Terima kasih sudah membaca :)