Γεια χαρά, Επισκέπτης

ΘΕΜΑ: Επεξήγηση παραμέτρων μιας συνάρτησης;

Επεξήγηση παραμέτρων μιας συνάρτησης; 10 Χρόνια 9 Μήνες πριν #2293

babaliaris1
Αποσυνδεμένος
python
Δημοσιεύσεις: 445
Ληφθείσες Ευχαριστίες 75

Καλησπέρα.

Φτιάχνω μια βιβλιοθήκη και θέλω να μάθω πως μπορώ να βάλω
επεξήγηση παραμέτρων στις συναρτήσεις.Για παράδειγμα στη python όταν πληκτρολογήσεις μια συνάρτηση και βάλεις την
πρώτη παρένθεση σε λέει τη παραμέτρους παίρνει.Πως μπορώ να
το κάνω αυτό;;;

Ευχαριστώ.

My GitHub Page

My Facebook Programming Page

Πρέπει να είστε εγγεγραμμένο μέλος του Φόρουμ για να κάνετε μια δημοσίευση.

Επεξήγηση παραμέτρων μιας συνάρτησης; 10 Χρόνια 9 Μήνες πριν #2294

kamar
Αποσυνδεμένος
python
Δημοσιεύσεις: 409
Ληφθείσες Ευχαριστίες 88

Απλώς, γράφεις τη συνάρτηση με τις παραμέτρους της.
Όταν την πληκτρολογήσεις για να την εκτελέσεις, με το που ανοίγεις την παρένθεση, εμφανίζεται το όνομα της. Αν θέλεις να εμφανίζεται μια μικρή περιγραφή, δημιουργείς ένα doc string, όπως φαίνεται παρακάτω.

def find_in_file(file_to_search):
        """Σύνάρτηση για εύρεση αλφαριθμητικού σε αρχείο.
		Παράμετρος: Η διαδρομή του αρχείου.
		"""
        pass

Γράφω σε Python 3

Πρέπει να είστε εγγεγραμμένο μέλος του Φόρουμ για να κάνετε μια δημοσίευση.

Επεξήγηση παραμέτρων μιας συνάρτησης; 10 Χρόνια 9 Μήνες πριν #2295

pmav99
Αποσυνδεμένος
Author
Δημοσιεύσεις: 684
Ληφθείσες Ευχαριστίες 111

Κάνε μια αναζήτηση για "python + docstring" και θα βρεις ολες τις πληροφορίες που χρειάζεσαι. Πρακτικά υπάρχουν οι ακόλουθοι βασικοί τρόποι που μπορείς να γράφεις τα docstrings σου:

1. Να ακολουθήσεις το PEP 257
2. Να ακολουθήσεις τις συμβάσεις της Google
3. Να ακολουθήσεις τις συμβάσεις του sphinx
4. Να ακολουθήσεις δικές σου συμβάσεις.

Αν θες η βιβλιοθήκη σου να έχει documentation σαν και αυτό τότε θες να ψαχτείς με το sphinx, αλλά να ξέρεις ότι το markup του documentation θα είναι πιο "βαρύ" από τις άλλες επιλογές. Αν θες να διαβάζεις το documentation απευθείας από τον κώδικα, το πιο ευανάγνωστο πρότυπο είναι αυτό της google.

LaTeX στα Ελληνικά

Πρέπει να είστε εγγεγραμμένο μέλος του Φόρουμ για να κάνετε μια δημοσίευση.

Επεξήγηση παραμέτρων μιας συνάρτησης; 10 Χρόνια 9 Μήνες πριν #2296

babaliaris1
Αποσυνδεμένος
python
Δημοσιεύσεις: 445
Ληφθείσες Ευχαριστίες 75

pmav99 έγραψε:

Κάνε μια αναζήτηση για "python + docstring" και θα βρεις ολες τις πληροφορίες που χρειάζεσαι. Πρακτικά υπάρχουν οι ακόλουθοι βασικοί τρόποι που μπορείς να γράφεις τα docstrings σου:

1. Να ακολουθήσεις το PEP 257
2. Να ακολουθήσεις τις συμβάσεις της Google
3. Να ακολουθήσεις τις συμβάσεις του sphinx
4. Να ακολουθήσεις δικές σου συμβάσεις.

Αν θες η βιβλιοθήκη σου να έχει documentation σαν και αυτό τότε θες να ψαχτείς με το sphinx, αλλά να ξέρεις ότι το markup του documentation θα είναι πιο "βαρύ" από τις άλλες επιλογές. Αν θες να διαβάζεις το documentation απευθείας από τον κώδικα, το πιο ευανάγνωστο πρότυπο είναι αυτό της google.

Ευχαριστώ!!!

My GitHub Page

My Facebook Programming Page

Πρέπει να είστε εγγεγραμμένο μέλος του Φόρουμ για να κάνετε μια δημοσίευση.

Επεξήγηση παραμέτρων μιας συνάρτησης; 10 Χρόνια 9 Μήνες πριν #2297

babaliaris1
Αποσυνδεμένος
python
Δημοσιεύσεις: 445
Ληφθείσες Ευχαριστίες 75

kamar έγραψε:

Απλώς, γράφεις τη συνάρτηση με τις παραμέτρους της.
Όταν την πληκτρολογήσεις για να την εκτελέσεις, με το που ανοίγεις την παρένθεση, εμφανίζεται το όνομα της. Αν θέλεις να εμφανίζεται μια μικρή περιγραφή, δημιουργείς ένα doc string, όπως φαίνεται παρακάτω.

def find_in_file(file_to_search):
        """Σύνάρτηση για εύρεση αλφαριθμητικού σε αρχείο.
		Παράμετρος: Η διαδρομή του αρχείου.
		"""
        pass

Αυτό να πω την αλήθεια δεν το κατάλαβα.
Απλός βάζω ένα string μέσα στην συνάρτηση
που θέλω με 3 (""") και το μήνυμα που
βρίσκετε μέσα θα το δείχνει ως επεξήγηση
την ώρα που πληκτρολογώ την συνάρτηση;

My GitHub Page

My Facebook Programming Page

Πρέπει να είστε εγγεγραμμένο μέλος του Φόρουμ για να κάνετε μια δημοσίευση.

Επεξήγηση παραμέτρων μιας συνάρτησης; 10 Χρόνια 9 Μήνες πριν #2298

kamar Αποσυνδεμένος python Δημοσιεύσεις: 409 Ληφθείσες Ευχαριστίες 88	Δεν έχεις παρά να το δοκιμάσεις. Όταν καλείς τη συνάρτηση στο idle, εμφανίζεται ως συμβουλή το όρισμα της συνάρτησης και η πρώτη γραμμή του docstring. Κατά τα άλλα όπως πολύ σωστά γράφει ο pmav99.
	Γράφω σε Python 3 Πρέπει να είστε εγγεγραμμένο μέλος του Φόρουμ για να κάνετε μια δημοσίευση.

Επεξήγηση παραμέτρων μιας συνάρτησης; 10 Χρόνια 9 Μήνες πριν #2299

babaliaris1
Αποσυνδεμένος
python
Δημοσιεύσεις: 445
Ληφθείσες Ευχαριστίες 75

kamar έγραψε:

Δεν έχεις παρά να το δοκιμάσεις. Όταν καλείς τη συνάρτηση στο idle, εμφανίζεται ως συμβουλή το όρισμα της συνάρτησης και η πρώτη γραμμή του docstring.
Κατά τα άλλα όπως πολύ σωστά γράφει ο pmav99.

Πράγματι δουλεύει!!!!
Ευχαριστώ πάρα πολύ!!!!!!

My GitHub Page

My Facebook Programming Page

Πρέπει να είστε εγγεγραμμένο μέλος του Φόρουμ για να κάνετε μια δημοσίευση.