Εμφάνιση της τεκμηρίωσης συναρτήσεων στην Python

Στο σώμα μιας συνάρτησης μπορεί να γραφεί μια συμβολοσειρά, που περιγράφει την ουσία της εργασίας που εκτελεί. Αυτή η συμβολοσειρά θεωρείται συνήθως ως τεκμηρίωση της συνάρτησης. Περικλείεται σε μονά εισαγωγικά και τοποθετείται στην πρώτη γραμμή του σώματος της συνάρτησης. Για να την διαβάσετε, πρέπει να χρησιμοποιήσετε την ειδική συνάρτηση help, στην παράμετρο της οποίας περνάται το όνομα της συνάρτησης.

Ας υποθέσουμε ότι έχουμε μια συνάρτηση που αθροίζει δύο αριθμούς. Για αυτό έχει αφεθεί μια συμβολοσειρά με τις αντίστοιχες πληροφορίες:

pythondef getSum(num1, num2):
  'this function sums two numbers'
  return num1 + num2

Ας καλέσουμε την help και ας μάθουμε τι έχει σχολιαστεί στην getSum:

pythonhelp(getSum)

Μετά την εκτέλεση του κώδικα στην κονσόλα θα εμφανιστεί μια γραμμή με το όνομα της συνάρτησης και την τεκμηρίωσή της:

pythonHelp on function getSum in module __main__:

getSum(num1, num2)
  this function sums two numbers

Με τη βοήθεια της συνάρτησης help μπορείτε να διαβάζετε την τεκμηρίωση και των τυπικών συναρτήσεων. Ας μάθουμε πληροφορίες για τη συνάρτηση print:

pythonhelp(print)

Για να εκτυπώσετε μόνο τη συμβολοσειρά με την τεκμηρίωση από τη συνάρτηση, πρέπει να περάσετε στην help μετά το όνομα της συνάρτησης την ειδική κατασκευή .__doc__:

pythonhelp(print.__doc__)