DERS 33 - Yorumlar

Komple eğitim serisinin bu dersinde python'daki comment veya yorumlar hakkında bilgi veriliyor.

Python Yorum Satırı ve Bloğu

Her programlama dillerinde yorum satırları özellike uzun ve karışık kodlarda yazılım mühendislerine büyük kolaylıklar sağlamaktadır. Python programlama dilinde yorum satırı # ile yapılmaktadır. Böyleki # işaretinden sonra boşluk bırakıp istediğimiz yorumu yazabiliriz.

# Kod Başlangıcı

Yorumlar bir satırdan daha fazla da olabilir

# Yazar: Ferhat Mousavi
# Ders: Python
# Konu: Yorumlar

daha gerçekçi bir örnek vermek gerekirse

# This function convert a created url for web application to url friendly url
# Parameters:
#       created_url_string: created url string as string
# Return:
#       Return value is url friendly of given string
def convert_url_safe(created_url_string: str) -> str:
    replace_character = {
        '/': '', '?': '', '=': '', '&': '', ',': '', 
        '!': '', '\'': '', '\"': '', '(': '', ')': '',
        '[': '', ']': '', '`': '', '’': '', '%': '', 
        '@': '', '#': '', '$': '', '^': '', '*': '',
        '{': '', '}': '', ';': '', ':': '', '“': ''
    }
    url_safe_string = created_url_string
    for character in replace_character:
        url_safe_string = 
        url_safe_string.replace(character, replace_character[character])
    return url_safe_string

Ayrıca Python'da belli metinleri blok halinde işlevsiz kılmak istediğimizde de başlarına # işareti koyarak yoruma çevirebiliriz. Ancak teker teker satırların başına # işareti koymak yorucu geldiğinden PEP8 dokümanında önerilmese üç tek tırnak veya üç çift tırnak ile de yorum haline getirebiliriz.

"""
Yazar: Ferhat Mousavi
Ders: Python
Konu: Yorumlar
"""

Yorumların farklı kullanımlarıda vardır. Bazı IDE'lerde örneğin PyCharm'da

# TODO: Daha sonra geliştir.

yazdığımızda, istediğimiz zaman TODO'ları aratıp bulup yazdığımız nota göre aksiyon alabiliriz.


DERSLER