Çok satırlı yorumların nasıl yazılacağını zaten bildiğimiz için, üçlü tek tırnak veya üçlü çift tırnak kullanabiliriz. İşlevlerimizi tanımlamak istediğimizde bir dokümantasyon dizisi kullanırız, böylece dokümantasyonu ihtiyacımız olduğunda alabiliriz. Bazı IDE'ler, yalnızca adın üzerine gelerek size belgeler sunar ve bazıları belirli anahtar kelimeleri vurgular. Ancak gerçek şu ki, NumPy'deki belge dizileri diğer dillerden çok daha esnektir. Docstring, işlev tanımının başlangıcında oluşan bir dize değişmezidir. İşlevler, sınıflar vb. durumlarda belge dizilerini kullanırken belirli değerler sağlamalıyız.
Doküman dizilerini işlevlerle kullanırken, argümanları iletmemiz gerekir. Bunları sınıflarla kullanırken öznitelikleri ve yöntemleri aktarıyoruz. Modüller söz konusu olduğunda, sınıfların ve işlevlerin bir listesini sağlamalıyız. Paket durumunda, işlevselliğe sahip modüllerin listesini geçiyoruz. Temel olarak, belge dizisinin amacı, adından da anlaşılacağı gibi, kodumuzun belgelenmesine yardımcı olmasıdır. Belgeleme yapıyoruz, böylece gelecekte biri kodumuzu kullanırsa, docstring yardımıyla kodumuzu ve kodumuzun arkasındaki mantığı anlayabilecektir. Yerleşik işlevlerde ayrıca belge dizileri bulunur; yerleşik işlevlerin belgelerine bakmak için help() işlevini kullanabiliriz.
Yorumlar ve dokümanlar arasında birkaç fark vardır. Yorumlar tercümanlar tarafından yoksayılır, ancak belge dizileri tercümanlar tarafından yoksayılmaz. Belge dizileri için bellek ayrılmıştır. Yorum, kodun bir açıklamasıdır, ancak diğer yandan dokümanlar bize kodun amacını söyler.
Sözdizimi:
NumPy'de belge dizilerini yazmak için kullanılan sözdizimi şöyledir:
'''Doküman dizisi mesajı'''
Veya
'''Doküman dizisi mesajı'''
Lütfen docstring'in bir işlev veya yöntem olmadığını, bu nedenle uygun sözdizimine sahip olmadığını unutmayın. Burada dikkat edilmesi gereken tek şey, doküman dizisine üç tek tırnak veya üç çift tırnak ile başlamamızdır. Kodun açıklamasını yazıyoruz ve sonunda üç tek tırnak veya üç çift tırnak ile tekrar bitiriyoruz. Belge dizileri için yazılması zorunlu bir şey yoktur. Dize açıklamanızdan önce ve sonra üç tek veya çift tırnak işareti koymanız yeterlidir.
Örnek 1:
Belge dizilerini daha iyi anlamak için bir örnek yapalım. Bu örnekte, NumPy kitaplığını ekledikten sonra, 'a' değişkenini ve başka bir 'b' değişkenini bildirmemiz yeterlidir. Ardından “a” ve “b” değişkenlerini ekleyelim diye docstringimizi oluşturuyoruz. Bizim durumumuzda, bu kolay bir örnek, ancak kodumuz karmaşıksa, bu kodlayıcının kodu anlamasında çok yardımcı olur. Bundan sonra, “a” ve “b” değişkenlerini toplarız ve çıktı sonuçlarını “c” olan başka bir değişkende saklarız. Son olarak “c” değişkeninin değerini yazdırıyoruz. Şimdi kodumuzu çalıştırıyoruz.
içe aktarmak dizi olarak Örneğin.a = 1
b = iki
'''a ve b değişkenlerini ekleyelim'''
c = a+b
Yazdır ( c )
Bu, verilen kod parçasından çıktımızdır. Kodumuzun 7. satırı için sistemin yanlış sözdizimi veya herhangi bir hata vermediğini görebiliriz. Ayrıca, sistem belgemizi yazdırmadı. Bunun yerine, yalnızca sistemimize yazdırmasını söylediğimiz “c” değişkenimizin çıktısını yazdırdı. Bu, belge dizilerinin nasıl çalıştığını gösterir. Bir dahaki sefere, yeni bir kodlayıcı kodumuz üzerinde çalışmaya çalıştığında, belge dizimizin yardımıyla ne yaptığımızı anlayacaktır. Ancak çıktı olarak yazdırılmayacak, böylece kodun kullanıcısı bundan rahatsız olmayacak.
Örnek 2:
Şimdi, dokümantasyonun çalışmasını anlamak için karmaşık bir örnek gerçekleştiriyoruz. İlk önce NumPy kitaplığını ekleriz ve ardından dizinin başlatılmasını açıkladığımız sonraki kod satırını açıkladığımız bir doc dizesi yazarız. Belge dizilerini de kodun diğer kısmına ekliyoruz. Şimdi, bu kodu herhangi bir yeni Python geliştiricisi ile docstrings eklemeden paylaşırsak, bu kodun çalışmasını ve amacını bilmesi bir şekilde zor olacaktır. Önce kullandığımız fonksiyonları araştırmalı. Ancak kodumuza bir doküman dizisi eklersek, diğer geliştiricilerin fonksiyonlar hakkında daha fazla çalışmadan kodu anlaması kolay olacaktır. Bazı sınırlara yorum eklemekle sınırlı değiliz; yorumlar bir veya birden fazla satır olabilir. Ayrıca bir koda birden fazla eklenebilir. Ardından NumPy'yi np olarak içe aktarın.
'''1x6 boyutunda bir dizi ileteceğimiz değişkeni oluşturma'''dizi = Örneğin. dizi ( [ on bir , 22 , 33 , 44 , 55 , 66 ] )
'''diziyi arr adlı dosyaya kaydetmesi için tofile() işlevine atama'''
dizi . dosyalamak ( 'arr.bin' )
'''dosyadan dosya işlevini kullanarak dosyayı görüntüle'''
Yazdır ( Örneğin. dosyadan ( 'arr.bin' , tip = int ) )
Aşağıdaki snippet'te gösterildiği gibi, çıktıda belge dizileri görüntülenmez, bu da kodun çıktısını veya derlenmesini etkilemediği anlamına gelir. Derleme işlemi sırasında belge dizileri yoksayılır.
Çözüm
Bu kılavuzda, NumPy'deki belge dizilerini öğrendik. Belge dizilerini yorumlarla karşılaştırdık ve ikisi arasındaki farkı açıkladık. Belge dizilerinin sözdizimini ve belge dizilerini kodumuzda nasıl yazacağımızı öğrendik. Ayrıca NumPy'deki dökümanların neler olduğunu ve nasıl çalıştıklarını örnekler yardımıyla açıklamaya çalıştık. Son olarak, kodlayıcılar için vazgeçilmez olduklarını belirttik. NumPy'de belge dizilerinin önemini tekrarlamayacağız. Sadece kodunuzdaki dokümanları kullanmanız gerektiğini söyleyeceğiz. NumPy'de, belge dizilerinin yazma stili en popüler olanıdır. Kodlarının işleyişi ve işlevselliği hakkında birbirlerine bilgi vermek için programlama topluluğunda yaygın olarak kullanılır. Bu kılavuz, NumPy belge dizilerini kullanmaya başlamanıza yardımcı olacaktır. NumPy'deki belge dizilerini kullanarak ihtiyaç duyacağınız şeylerin çoğunu kapsamaya çalıştık.