Python老教程， 多角度看教程，不一樣的感覺

摘要： 快過來，小編給你把Python老教程翻出來了。對比一下那裡不一樣。 文件字串 Python有一種獨一無二的的註釋方式: 使用文件字串. 文件字串是包, 模組, 類或函式裡的第一個語句. 這些字串可以通過物件的 doc 成員被自動提取, 並且被pydoc所用. (你...

快過來，小編給你把Python老教程翻出來了。對比一下那裡不一樣。

文件字串

Python有一種獨一無二的的註釋方式: 使用文件字串. 文件字串是包, 模組, 類或函式裡的第一個語句. 這些字串可以通過物件的 doc 成員被自動提取, 並且被pydoc所用. (你可以在你的模組上執行pydoc試一把, 看看它長什麼樣). 我們對文件字串的慣例是使用三重雙引號”“”( PEP-257 ). 一個文件字串應該這樣組織: 首先是一行以句號, 問號或驚歎號結尾的概述(或者該文件字串單純只有一行). 接著是一個空行. 接著是文件字串剩下的部分, 它應該與文件字串的第一行的第一個引號對齊. 下面有更多文件字串的格式化規範.

模組

每個檔案應該包含一個許可樣板. 根據專案使用的許可(例如, Apache 2.0, BSD, LGPL, GPL), 選擇合適的樣板.

函式和方法

下文所指的函式,包括函式, 方法, 以及生成器.

一個函式必須要有文件字串, 除非它滿足以下條件:

• 外部不可見
• 非常短小
• 簡單明瞭

文件字串應該包含函式做什麼, 以及輸入和輸出的詳細描述. 通常, 不應該描述”怎麼做”, 除非是一些複雜的演算法. 文件字串應該提供足夠的資訊, 當別人編寫程式碼呼叫該函式時, 他不需要看一行程式碼, 只要看文件字串就可以了. 對於複雜的程式碼, 在程式碼旁邊加註釋會比使用文件字串更有意義.

關於函式的幾個方面應該在特定的小節中進行描述記錄， 這幾個方面如下文所述. 每節應該以一個標題行開始. 標題行以冒號結尾. 除標題行外, 節的其他內容應被縮排2個空格.

需要Python教程的加小編的QQ群 哦！免費教程

文章來自網路，如有侵權聯絡小編刪除！