在我剛開始接觸Python的日子里,我最喜歡做的事情之一是坐在解釋器旁使用內(nèi)置help功能來檢查類和方法,決定下一個(gè)要敲的內(nèi)容。這個(gè)功能導(dǎo)入一個(gè)對象,遍布它的成員,取出文檔注釋,生成一個(gè)類似manpage的輸出,從而幫助你找到如何使用正在檢查的對象的方法。
它被內(nèi)置成一個(gè)標(biāo)準(zhǔn)庫的美妙之處在于通過代碼直接生成輸出,它為我這樣的懶人間接地強(qiáng)調(diào)了一個(gè)編碼風(fēng)格,我就想著在盡量少做額外的工作的情況下維護(hù)文檔。尤其是如果你已經(jīng)為你的變量和函數(shù)選擇直接的名字。 這種風(fēng)格涉及到向你的函數(shù)和類添加文檔字符串,以及通過用下劃線前綴來正確地識(shí)別私有成員和受保護(hù)成員。
Help style="color: #333333; font-weight: bold;">class list in module builtins:class list(object) | list() -> new empty list | list(iterable) -> new list initialized from iterable's items | | Methods defined here: | | __add__(self, value, /) | Return self+value. ... | __iter__(self, /) | Implement iter(self).... | append(...) | L.append(object) -> None -- append object to end | | extend(...) | L.extend(iterable) -> None -- extend list by appending elements from the iterable | | index(...) | L.index(value, [start, [stop]]) -> integer -- return first index of value. | Raises ValueError if the value is not present. ... | pop(...) | L.pop([index]) -> item -- remove and return item at index (default last). | Raises IndexError if list