python文檔

形式 # 角色

註釋 文件中的文檔

dir函數 對象中可用屬性的列表

文檔字符串__doc__ 附加在對象文件中的文檔

標準手冊 正式的語言和庫的說明

網站 在線教程，例子

書籍 商業參考書籍

註釋

代碼編寫的最基本的方式，文檔字符串用於較大功能的文檔

而# 用於較小功能的文檔

dir函數

抓取對象內可用的全部屬性列表的簡單方式

import random

print(dir(random))

['BPF', 'LOG4', 'NV_MAGICCONST', 'RECIP_BPF', 'Random', 'SG_MAGICCONST',

'SystemRandom', 'TWOPI', '_BuiltinMethodType', '_MethodType', '_Sequence',

'_Set', 'all', 'builtins', 'cached', 'doc', 'file',

'loader', 'name', 'package', 'spec', '_acos', '_bisect',

'_ceil', '_cos', '_e', '_exp', '_inst', '_itertools', '_log', '_pi', '_random',

'_sha512', '_sin', '_sqrt', '_test', '_test_generator', '_urandom', '_warn',

'betavariate', 'choice', 'choices', 'expovariate', 'gammavariate', 'gauss',

'getrandbits', 'getstate', 'lognormvariate', 'normalvariate', 'paretovariate',

'randint', 'random', 'randrange', 'sample', 'seed', 'setstate', 'shuffle',

'triangular', 'uniform', 'vonmisesvariate', 'weibullvariate']

print(dir('1') == dir(''))

True

__doc__文檔字符串，這類註釋是寫成字符串，放在模塊文件，函數以及語句的頂端

在可執行代碼執行前，會自動封裝這個字符串，也就是文檔字符串，使他成爲__doc__

屬性

內置文檔字符串能夠用__doc_來查看
import sys

print(sys.__doc__)

...

print(sys.getrefcount.__doc__)

getrefcount(object) -> integer

Return the reference count of object. The count returned is generally

one higher than you might expect, because it includes the (temporary)

reference as an argument to getrefcount().

print(int.__doc__)

...

help函數

啓動pydoc來查看文檔，如help函數和PyDocGUI、HTML接口

print(help(int))

...

常見編寫代碼陷阱

別忘了複合語句末尾輸入':'

要肯定頂層程序代碼從第1行開始

空白行在交互模式下是告訴交互模式命令行完成複合語句

縮進要一致，儘可能使用統一縮進，統一製表符或者四個空格

不要在python中寫c代碼。由於這樣不pythonic

使用簡單的for循環或者解析，而不是while和range

要注意賦值語句中的可變對象。a = b = [],a += [1, 2]都會在原處修改

# 會影響其餘變量

不要期待在原處修改對象的函數返回結果，[1,2,3],append(4)他們只會返回None

要使用括號調用函數，否則只會返回他們的函數命名空間

不要在導入和重載中使用擴展名或者路徑 import mod 而不是import mod.py