python文檔

#形式 # 角色

注釋 文件中的文檔

dir函數(shù) 對(duì)象中可用屬性的列表

文檔字符串doc 附加在對(duì)象文件中的文檔

標(biāo)準(zhǔn)手冊(cè) 正式的語(yǔ)言和庫(kù)的說(shuō)明

網(wǎng)站 在線教程，例子

書籍 商業(yè)參考書籍

注釋

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

而# 用于較小功能的文檔

dir函數(shù)

#抓取對(duì)象內(nèi)可用的所有屬性列表的簡(jiǎn)單方式

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文檔字符串，這類注釋是寫成字符串，放在模塊文件，函數(shù)以及語(yǔ)句的頂端

#在可執(zhí)行代碼執(zhí)行前，會(huì)自動(dòng)封裝這個(gè)字符串，也就是文檔字符串，使他成為doc

屬性

#內(nèi)置文檔字符串可以用__doc_來(lái)查看
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函數(shù)

啟動(dòng)pydoc來(lái)查看文檔，如help函數(shù)和PyDocGUI、HTML接口

print(help(int))

...

常見(jiàn)編寫代碼陷阱

別忘了復(fù)合語(yǔ)句末尾輸入':'

要確定頂層程序代碼從第1行開(kāi)始

空白行在交互模式下是告訴交互模式命令行完成復(fù)合語(yǔ)句

縮進(jìn)要一致，盡量使用統(tǒng)一縮進(jìn)，統(tǒng)一制表符或者四個(gè)空格

不要在python中寫c代碼。因?yàn)檫@樣不pythonic

使用簡(jiǎn)單的for循環(huán)或者解析，而不是while和range

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

# 會(huì)影響其他變量

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

要使用括號(hào)調(diào)用函數(shù)，不然只會(huì)返回他們的函數(shù)命名空間

不要在導(dǎo)入和重載中使用擴(kuò)展名或者路徑 import mod 而不是import mod.py