Dokumentacijski string

Dokumentacijski string omogućava programeru da unese određene komentare i objašnjenja za funkcije koje sam piše.
U Pajtonu možemo pisati dokumentacijski string, poznatiji kao docstring.

Dokumentacijski string se često proteže u nekoliko fizičkih linija, te se stoga obično označava unutar trostrukih navodnika:

 
def zbir(x,y):
    """Prihvati dva numericka argumenta i vrati njihov zbir"""
    return x+y
    


Njihova je uloga slična komentarima u bilo kojem programskom jeziku, ali im je korisnost šira, jer su dostupni pri procesu pokretanja programa.

Programerska okruženja i drugi alati mogu koristiti dokumentacijske stringove da podsete programera kako koristiti određene objekte. To znači da deluju kao pomoć programa kada se zatraže.

U sledećem primeru je napisan dokumentacijski string za funkciju zbir tj. kratko objašnjenje šta ta funkcija radi. Da bi to objašnjenje videli tj. da bi se dokumentacijski string ispisao na komandnoj liniji koristimo help(zbir).

  
def zbir(x,y):
    """Prihvati dva broja i vrati njihov zbir"""
    return x+y 

print (zbir(2,3))

help(zbir)  #trazimo da nam se pri pokretanju programa
              #ispiše docstring za funkciju zbir

            

Nakon pokretanja programa kao rezultat dobićemo:
>> 5
>> Prihvati dva broja i vrati njihov zbir
>> For detailed help, run 'from pydoc import help' (slow).