{"id":546,"date":"2023-10-30T15:49:10","date_gmt":"2023-10-30T12:49:10","guid":{"rendered":"https:\/\/www.facadium.com.tr\/blog\/?p=546"},"modified":"2023-10-30T15:49:10","modified_gmt":"2023-10-30T12:49:10","slug":"pythonda-fonksiyon-belgeleri-docstring","status":"publish","type":"post","link":"https:\/\/www.facadium.com.tr\/blog\/pythonda-fonksiyon-belgeleri-docstring\/","title":{"rendered":"Python’da Fonksiyon Belgeleri (Docstring)"},"content":{"rendered":"\n

Ne Yaparlar ve Nas\u0131l Kullan\u0131l\u0131r?<\/h2>\n\n\n\n

Python programlama dilinde, fonksiyon belgeleri (docstring), fonksiyonlar\u0131n ne yapt\u0131\u011f\u0131n\u0131 a\u00e7\u0131klayan ve nas\u0131l kullan\u0131lmas\u0131 gerekti\u011fini tan\u0131mlayan metinlerdir. Bu belgeler, kodunuzu anla\u015f\u0131l\u0131r hale getirmenin ve di\u011fer geli\u015ftiricilere rehberlik etmenin \u00f6nemli bir par\u00e7as\u0131d\u0131r.<\/p>\n\n\n\n

Fonksiyon Belgeleri (Docstring) Nedir?<\/h3>\n\n\n\n

Fonksiyon belgeleri veya docstring’ler, bir fonksiyonun hemen alt\u0131nda \u00fc\u00e7l\u00fc tek t\u0131rnak veya \u00fc\u00e7l\u00fc \u00e7ift t\u0131rnak i\u00e7ine yaz\u0131lan metinlerdir. Bu metinler, fonksiyonun ne yapt\u0131\u011f\u0131n\u0131, nas\u0131l kullan\u0131lmas\u0131 gerekti\u011fini ve hangi parametreleri kabul etti\u011fini a\u00e7\u0131klar. Python toplulu\u011fu, iyi bir kod belgesi yazman\u0131n \u00f6nemini vurgular ve bu nedenle docstring kullan\u0131m\u0131 te\u015fvik eder.<\/p>\n\n\n\n

Fonksiyon Belgeleri Nas\u0131l Olu\u015fturulur?<\/h3>\n\n\n\n

Fonksiyon belgesi (docstring) olu\u015fturmak i\u00e7in, bir fonksiyonu tan\u0131mlad\u0131ktan sonra hemen a\u015fa\u011f\u0131s\u0131na \u00fc\u00e7l\u00fc tek t\u0131rnak veya \u00fc\u00e7l\u00fc \u00e7ift t\u0131rnak i\u00e7inde belge metnini eklemeniz yeterlidir. \u0130\u015fte bir \u00f6rnek:<\/p>\n\n\n\n

def toplama(a, b):\r\n    \"\"\"\r\n    \u0130ki say\u0131y\u0131 toplar.\r\n\r\n    Parametreler:\r\n    a (float): Toplama i\u015flemi i\u00e7in ilk say\u0131.\r\n    b (float): Toplama i\u015flemi i\u00e7in ikinci say\u0131.\r\n\r\n    D\u00f6n\u00fc\u015f De\u011feri:\r\n    float: \u0130ki say\u0131n\u0131n toplam\u0131.\r\n    \"\"\"\r\n    sonuc = a + b\r\n    return sonuc\r<\/code><\/pre>\n\n\n\n
Yukar\u0131daki \u00f6rnekte, toplama<\/code> fonksiyonunun docstring’i \u00fc\u00e7l\u00fc t\u0131rnak i\u00e7inde yer al\u0131r. Bu docstring, fonksiyonun ne yapt\u0131\u011f\u0131n\u0131, hangi parametreleri ald\u0131\u011f\u0131n\u0131 ve d\u00f6n\u00fc\u015f de\u011ferini a\u00e7\u0131klar.<\/p>\n\n\n\n
Fonksiyon Belgelerini (Docstring) Kullanma<\/h3>\n\n\n\n
Fonksiyon belgesi (docstring), a\u015fa\u011f\u0131daki \u015fekillerde kullan\u0131labilir:<\/p>\n\n\n\n
help()<\/code> Fonksiyonu<\/h4>\n\n\n\n
Python’un help()<\/code> fonksiyonunu kullanarak bir fonksiyonun docstring’ini g\u00f6r\u00fcnt\u00fcleyebilirsiniz. \u0130\u015fte bir \u00f6rnek:<\/p>\n\n\n\n
help(toplama)\r<\/code><\/pre>\n\n\n\n
Bu komut, toplama<\/code> fonksiyonunun docstring’ini g\u00f6r\u00fcnt\u00fcler ve kullan\u0131c\u0131ya fonksiyonun nas\u0131l kullan\u0131lmas\u0131 gerekti\u011fi hakk\u0131nda bilgi verir.<\/p>\n\n\n\n
Otomatik Belge \u00dcretme Ara\u00e7lar\u0131<\/h4>\n\n\n\n
Python i\u00e7in \u00e7e\u015fitli belge \u00fcretme ara\u00e7lar\u0131 vard\u0131r. Sphinx gibi ara\u00e7lar, projeniz i\u00e7in otomatik olarak belge \u00fcretmenize olanak tan\u0131r. Bu ara\u00e7lar, docstring’leri kullanarak projenizin ayr\u0131nt\u0131l\u0131 belgelerini olu\u015fturabilir.<\/p>\n\n\n\n
\u0130yi Bir Docstring Nas\u0131l Olu\u015fturulur?<\/h3>\n\n\n\n
\u0130yi bir docstring olu\u015ftururken a\u015fa\u011f\u0131daki ipu\u00e7lar\u0131na dikkat edin:<\/p>\n\n\n\n
    \n
  • Fonksiyonun ne yapt\u0131\u011f\u0131n\u0131 ve nas\u0131l kullan\u0131laca\u011f\u0131n\u0131 a\u00e7\u0131k\u00e7a belirtin.<\/li>\n\n\n\n
  • Parametreleri, her bir parametrenin ad\u0131n\u0131, t\u00fcr\u00fcn\u00fc ve a\u00e7\u0131klamas\u0131n\u0131 i\u00e7eren bir \u015fekilde belirtin.<\/li>\n\n\n\n
  • D\u00f6n\u00fc\u015f de\u011ferini ve d\u00f6n\u00fc\u015f de\u011feri t\u00fcr\u00fcn\u00fc a\u00e7\u0131klay\u0131n.<\/li>\n\n\n\n
  • \u00d6rnekler veya kullan\u0131m senaryolar\u0131 ekleyerek fonksiyonun nas\u0131l kullan\u0131laca\u011f\u0131n\u0131 g\u00f6sterin.<\/li>\n<\/ul>\n\n\n\n
    \u0130\u015fte daha ayr\u0131nt\u0131l\u0131 bir \u00f6rnek:<\/p>\n\n\n\n
    def carpma(a, b):\r\n    \"\"\"\r\n    \u0130ki say\u0131y\u0131 \u00e7arpar.\r\n\r\n    Bu fonksiyon, verilen iki say\u0131y\u0131 \u00e7arparken kullan\u0131l\u0131r.\r\n\r\n    Parametreler:\r\n    a (float): \u00c7arpma i\u015flemi i\u00e7in ilk say\u0131.\r\n    b (float): \u00c7arpma i\u015flemi i\u00e7in ikinci say\u0131.\r\n\r\n    D\u00f6n\u00fc\u015f De\u011feri:\r\n    float: \u0130ki say\u0131n\u0131n \u00e7arp\u0131m\u0131.\r\n    \r\n    \u00d6rnekler:\r\n    >>> carpma(5, 3)\r\n    15.0\r\n    >>> carpma(2.5, 4)\r\n    10.0\r\n    \"\"\"\r\n    sonuc = a * b\r\n    return sonuc\r<\/code><\/pre>\n\n\n\n
    \u00d6zet<\/h3>\n\n\n\n
    Python’da fonksiyon belgeleri (docstring), kodunuzu a\u00e7\u0131klamak, anla\u015f\u0131l\u0131r hale getirmek ve di\u011fer geli\u015ftiricilere rehberlik etmek i\u00e7in kullan\u0131l\u0131r. Bir fonksiyonun docstring’ini olu\u015fturmak i\u00e7in \u00fc\u00e7l\u00fc tek t\u0131rnak veya \u00fc\u00e7l\u00fc \u00e7ift t\u0131rnak i\u00e7ine metni eklemeniz yeterlidir. help()<\/code> fonksiyonu veya otomatik belge \u00fcretme ara\u00e7lar\u0131yla docstring’i g\u00f6r\u00fcnt\u00fcleyebilirsiniz. \u0130yi bir docstring, fonksiyonun ne yapt\u0131\u011f\u0131n\u0131, nas\u0131l kullan\u0131laca\u011f\u0131n\u0131 ve hangi parametreleri kabul etti\u011fini a\u00e7\u0131klar, b\u00f6ylece kodunuzu daha anla\u015f\u0131l\u0131r ve kullan\u0131\u015fl\u0131 hale getirir.<\/p>\n","protected":false},"excerpt":{"rendered":"
    Ne Yaparlar ve Nas\u0131l Kullan\u0131l\u0131r? Python programlama dilinde, fonksiyon belgeleri (docstring), fonksiyonlar\u0131n ne yapt\u0131\u011f\u0131n\u0131 a\u00e7\u0131klayan ve nas\u0131l kullan\u0131lmas\u0131 gerekti\u011fini tan\u0131mlayan metinlerdir. Bu belgeler, kodunuzu anla\u015f\u0131l\u0131r […]<\/p>\n","protected":false},"author":3,"featured_media":547,"comment_status":"closed","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[5],"tags":[8,9],"class_list":["post-546","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-python","tag-python","tag-yazilim"],"_links":{"self":[{"href":"https:\/\/www.facadium.com.tr\/blog\/wp-json\/wp\/v2\/posts\/546","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.facadium.com.tr\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.facadium.com.tr\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.facadium.com.tr\/blog\/wp-json\/wp\/v2\/users\/3"}],"replies":[{"embeddable":true,"href":"https:\/\/www.facadium.com.tr\/blog\/wp-json\/wp\/v2\/comments?post=546"}],"version-history":[{"count":1,"href":"https:\/\/www.facadium.com.tr\/blog\/wp-json\/wp\/v2\/posts\/546\/revisions"}],"predecessor-version":[{"id":548,"href":"https:\/\/www.facadium.com.tr\/blog\/wp-json\/wp\/v2\/posts\/546\/revisions\/548"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/www.facadium.com.tr\/blog\/wp-json\/wp\/v2\/media\/547"}],"wp:attachment":[{"href":"https:\/\/www.facadium.com.tr\/blog\/wp-json\/wp\/v2\/media?parent=546"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.facadium.com.tr\/blog\/wp-json\/wp\/v2\/categories?post=546"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.facadium.com.tr\/blog\/wp-json\/wp\/v2\/tags?post=546"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}