Numpy Docstring
Ponieważ wiemy już, jak napisać komentarze wielopasmowe, możemy użyć potrójnych pojedynczych cytatów lub potrójnych podwójnych cytatów. Używamy ciągu dokumentacji, gdy chcemy opisać nasze funkcje, abyśmy mogli uzyskać dokumentację, gdy jej potrzebujemy. Niektóre IDE podają dokumentację, po prostu unosząc się nad nazwą, a niektóre wyróżniają niektóre słowa kluczowe. Ale faktem jest, że Docstrings w Numpy są o wiele bardziej elastyczne niż w innych językach. DocString jest literałem ciągłym, który występuje na początku definicji funkcji. Musimy podać określone wartości podczas korzystania z dokumentów w przypadku funkcji, klas itp.
Korzystając z dokumentów z funkcjami, musimy przekazać argumenty. Korzystając z nich z klasami, przekazujemy atrybuty i metody. W przypadku modułów musimy podać listę klas i funkcji. W przypadku pakietu przekazujemy listę modułów z funkcjonalnością. Zasadniczo celem DocString jest, jak sama nazwa wyjaśnia, że pomaga w dokumentacji naszego kodu. Prowadzimy dokumentację, aby jeśli ktoś użył naszego kodu w przyszłości, będzie mógł zrozumieć nasz kod i logikę naszego kodu za pomocą DocString. Wbudowane funkcje mają również dokumenty; Możemy użyć funkcji HELL (), aby spojrzeć na dokument wbudowanych funkcji.
Istnieje kilka różnic między komentarzami i doktorami. Komentarze są ignorowane przez tłumaczy, ale dokumenty nie są ignorowane przez tłumaczy. Pamięć jest przydzielona do dokumentów. Komentarz jest opisem kodu, ale z drugiej strony Docstrings informuje nam cel kodu.
Składnia:
Składnia do napisania Docstrings w Numpy to:
„„ „DocString Message” „”Lub
„Wiadomość DocString”
Należy pamiętać, że DocString nie jest funkcją ani metodą, więc nie ma właściwej składni. Jedyną rzeczą, na którą należy zwrócić uwagę, to to, że rozpoczynamy DocString z trzema pojedynczymi cytatami lub trzema podwójnymi cytatami. Piszemy nasz opis kodu i kończymy go ponownie trzema pojedynczymi cytatami lub trzema podwójnymi cytatami na końcu. Nie ma obowiązkowej rzeczy do pisania dla dokumentów. Musisz tylko umieścić trzy pojedyncze lub podwójne cytaty przed i po opisie ciągu.
Przykład 1:
Aby lepiej zrozumieć Docstrings, wykonajmy przykład. W tym przykładzie, po uwzględnieniu biblioteki Numpy, po prostu deklarujemy zmienną „A” i inną zmienną „B”. Następnie tworzymy nasz dokument, który mówi „Dodajmy zmienne„ A ”i„ B ””. W naszym przypadku jest to łatwy przykład, ale jeśli nasz kod jest złożony, pomaga to koderowi w zrozumieniu kodu. Następnie podsumowujemy zmienne „a” i „b” i przechowujemy wynik wyjściowy w innej zmiennej, która jest „c”. Na koniec drukujemy wartość zmiennej „C”. Teraz wykonujemy nasz kod.
importować Numpy jako NPa = 1
B = 2
„Dodajmy zmienne A i B”
C = A+B
Drukuj (c)
To jest nasze wyjście z danego kawałka kodu. Widzimy, że system nie podał żadnego błędu w kwestii nieprawidłowej składni lub niczego dla linii 7 naszego kodu. Ponadto system nie wydrukował naszego dokumentu. Zamiast tego wydrukował tylko wyjście naszej zmiennej „C”, w której powiedzieliśmy naszemu systemowi, aby wydrukował. To pokazuje, jak działają Docstrings. Następnym razem, gdy nowy koder próbuje popracować nad naszym kodem, zrozumie, co robimy z pomocą naszego dokumentu. Ale nie zostanie wydrukowany jako wyjście, więc użytkownik kodu nie będzie przez niego zakłócony.
Przykład 2:
Teraz wykonujemy złożony przykład, aby zrozumieć działanie DocString. Najpierw dołączamy bibliotekę Numpy, a następnie piszemy ciąg DOC, w którym wyjaśniamy następny wiersz kodu, w którym wyjaśniamy inicjalizację tablicy. Dodajemy również dokumenty w drugiej części kodu. Teraz, jeśli udostępnimy ten kod dowolnemu nowemu programistowi Pythona bez dodawania dokumentów, w jakiś sposób będzie mu trudno poznać działające i cel tego kodu. Musi najpierw szukać funkcji, których używaliśmy. Ale jeśli dodamy DOCSTRING do naszego kodu, pozostali programiści łatwo będzie zrozumieć kod bez studiowania więcej na temat funkcji. Nie ograniczamy się do dodawania komentarzy do niektórych granic; Komentarze mogą być jedna lub więcej niż jedna linia. Można go również dodać więcej niż raz w kodzie. Następnie importuj Numpy jako NP.
„Tworzenie zmiennej, do której przejdziemy szereg rozmiaru 1x6”array = np.tablica ([11, 22, 33, 44, 55, 66])
„Przypisanie tablicy do funkcji toFile (), aby pozwolić jej zapisać w pliku o nazwie ARR”
szyk.tofile („ARR.kosz")
„Wyświetl plik za pomocą funkcji FILE”
Drukuj (NP.From File („ARR.bin ", dtype = int))
Jak pokazano w poniższym fragmencie, dokumenty nie są wyświetlane na wyjściu, co oznacza, że nie wpływa on na wyjście ani kompilację kodu. Docstrings są ignorowane podczas procesu kompilacji.
Wniosek
W tym przewodniku dowiedzieliśmy się o dokumentach w Numpy. Porównaliśmy dokumenty z komentarzami i wyjaśniliśmy różnicę między nimi obojga. Nauczyliśmy się składni Docstrings i sposobu pisania dokumentów w naszym kodzie. Ponadto próbowaliśmy również wyjaśnić, jakie są dokumenty w Numpy i jak działają za pomocą przykładów. Wreszcie zauważyliśmy, że są one niezbędne dla programistów. Nie powtórzymy znaczenia dokumentów w Numpy. Powiemy tylko, że powinieneś używać Docstrings w swoim kodzie. W Numpy styl pisania Docstrings jest najpopularniejszy. Jest powszechnie używany w społeczności programowania, aby poinformować się o pracy i funkcjonalności ich kodów. Ten przewodnik pomoże Ci zacząć z Numpy Docstrings. Próbowaliśmy omówić większość tego, czego potrzebujesz za pomocą Docstrings w Numpy.