docstring
Co to jest standardowy format Python docstring? [zamknięte]
zamknięte . To pytanie jest oparte na opinii . Obecnie nie przyjmuje odpowiedzi.
...
Widziałem kilka różnych stylów pisania docstrings w Pythonie, czy istnieje oficjalny lub" uzgodniony " styl?
Jak skomentować blok kodu w Pythonie [duplicate]
to pytanie ma już odpowiedzi tutaj :
... komentarza, pojawia się w Wygenerowanej dokumentacji.
Po przeczytaniu wszystkich komentarze, odpowiedź wydaje się być "nie".
Korzystanie z javadoc dla dokumentacji Pythona [zamknięty]
Obecnie zaczynam od Pythona i mam silne tło PHP i w PHP nabrałem nawyku używania javadoc jako szablonu dokumentacji.
Zastana ... ame,
'%priority%' : priority,
'%message%' : message}
return self.__pattern.format(**values)
Czy istnieją realne alternatywy dla reStructuredText dla dokumentacji Pythona? [zamknięte]
Wkrótce zaczynam projekt open source Pythona i staram się z góry zdecydować, jak napisać moje docstringi. Oczywistą odpowiedz ... własnego dokumentu API. Na przykład, czy istnieje rozszerzenie dla Sphinx, które obsługuje styl docstring Google Style Guide?
Jak udokumentować Kod Pythona za pomocą doxygen [zamknięty]
Lubię doxygen tworzyć dokumentację kodu C lub PHP. Mam nadchodzący projekt Pythona i myślę, że pamiętam, że Python nie ma Kom ... aznajomiony z doxygen, Jak mogę go użyć do stworzenia dokumentacji Pythona? Czy jest coś szczególnego, o czym muszę wiedzieć?
Jak udokumentować atrybuty klas w Pythonie? [zamknięte]
zamknięte . To pytanie jest oparte na opinii. Obecnie nie przyjmuje odpowiedzi.
... całkiem nowy w Pythonie i nadal pracuję nad szczegółami stylu kodowania, więc mile widziane są również niepowiązane krytyki.
Dodawanie docstrings do namedtuples?
Czy można w prosty sposób dodać ciąg dokumentacji do nazwaple?
Próbowałem
from collections import namedtuple
Point = name ... # -> "Point(x, y)"
print Point2.__doc__ # -> "Point2(x, y)"
Ale to nie wystarczy. Czy można to zrobić w inny sposób?
Jak wydrukować Docstring funkcji Pythona z wnętrza samej funkcji?
Chcę wydrukować docstring funkcji Pythona z wnętrza samej funkcji.
dla np.
def my_function(self):
"""Doc string for my fun ... dodzwonić print self.__doc__ print self.my_function.__doc__ i print this.__doc__ wewnątrz my_function, ale to nie zadziałało.
Niestandardowe stuby PyCharm docstring (np. dla formatów Google docstring lub numpydoc)
Czy PyCharm 2.7 (lub PyCharm 3) ma wsparcie dla niestandardowych stubów docstring i doctest? Jeśli tak, to jak można napisać ... czególne znaczenie ma tutaj włączenie możliwości wnioskowania typu, które PyCharm ma z pozostałymi dwoma typami dokumentacji.
Python decorator obsługa docstrings
Mam problem z używaniem docstrings z dekoratorami. Podano następujący przykład:
def decorator(f):
def _decorator():
... funkcji nie jest już funkcją foo. Ale jakie jest dobre rozwiązanie, aby uzyskać docstring (i pomoc) zgodnie z oczekiwaniami?
Jak umieścić zmienną w Pythonie docstring
Więc staram się stworzyć" dynamiczny " docstring, który jest coś takiego:
ANIMAL_TYPES = ["mammals", "reptiles", "other"]
... string będzie aktualizowany automatycznie.
Niestety, to nie działa... Czy ktoś wie, czy jest jakiś sposób, aby to osiągnąć?
Jak znaleźć adnotacje w obiekcie PHP5?
Chciałbym móc implementować niestandardowe adnotacje w moich obiektach PHP5 i chciałbym dowiedzieć się, jak działa cały proce ... je, czy jest inny sposób?
Na przykład, chciałbym móc znaleźć następującą adnotację w klasie:
/**
* @MyParam: myvalue
*/