|
大小: 1188
說明:
|
← 2009-04-01 04:14:21 修訂第 6 版 ⇥
大小: 1293
說明: converted to 1.6 markup
|
| 這個顏色代表刪除的 | 這個顏色代表增加的 |
| 行號 1: | 行號 1: |
| 自從 Donald Knuth 大師發展出 WEB 這一套 literate programming 工具後，十幾二十年的時間，都沒有獲得應有的重視。一直到 Java 開始流行， JavaDoc 隨之廣為流傳後，從 source code 產生 document 的想法，才又再一次被重視。當然，從 source code 產生 document 並不是 literate 的全部。 | 自從 Donald Knuth 大師發展出 WEB 這一套 [[http://en.wikipedia.org/wiki/Literate_programming|literate programming]] 工具後，十幾二十年的時間，都沒有獲得應有的重視。一直到 Java 開始流行， JavaDoc 隨之廣為流傳後，從 source code 產生 document 的想法，才又再一次被重視。當然，從 source code 產生 document 並不是 literate 的全部。 |
| 行號 3: | 行號 3: |
| 相對於 Java ，將文件說明放在特定的位置的 comment ， Python 本身就有 DocString 的設計。在 module 、 function 、 或 class 的一開始位置， programmer 可以放置一字串，以做為說明。這個字串緊附在該物件，為其一部分。做為 dyanmic typing language ， Python 的 DocString 連在 runtime 都緊身相隨。這些緊附在物件上的 DocString ，除了可做靜態的說明，也能動態的查閱。在 CPython 本身，也隨著軟體包含 pydoc 這個工具，能將 DocString 抽取出來，並重新格式化後，產生靜態文件。除了 pydoc 之外，也有許多其它功能更強的工具，如 Epydoc ，能產生更美觀的文件，更豐富的圖形。 | 相對於 Java ，將文件說明放在特定的位置的 comment ， Python 本身就有 DocString 的設計。在 module 、 function 、 或 class 的一開始位置， programmer 可以放置一字串，以做為說明。這個字串緊附在該物件，為其一部分。做為 dyanmic typing language ， Python 的 DocString 連在 runtime 都緊身相隨。這些緊附在物件上的 DocString ，除了可做靜態的說明，也能動態的查閱。在 CPython 本身，也隨著軟體包含 [[pydoc]] 這個工具，能將 DocString 抽取出來，並重新格式化後，產生靜態文件。除了 [[pydoc]] 之外，也有許多其它功能更強的工具，如 [[Epydoc]] ，能產生更美觀的文件，更豐富的圖形。 |
| 行號 5: | 行號 5: |
| * [http://epydoc.sourceforge.net/ Epydoc] * [http://docs.python.org/lib/module-pydoc.html pydoc] |
== 相關工具 == * [[http://epydoc.sourceforge.net/|Epydoc]] * [[http://docs.python.org/lib/module-pydoc.html|pydoc]] * 更多 ... |
自從 Donald Knuth 大師發展出 WEB 這一套 literate programming 工具後，十幾二十年的時間，都沒有獲得應有的重視。一直到 Java 開始流行， JavaDoc 隨之廣為流傳後，從 source code 產生 document 的想法，才又再一次被重視。當然，從 source code 產生 document 並不是 literate 的全部。
相對於 Java ，將文件說明放在特定的位置的 comment ， Python 本身就有 DocString 的設計。在 module 、 function 、 或 class 的一開始位置， programmer 可以放置一字串，以做為說明。這個字串緊附在該物件，為其一部分。做為 dyanmic typing language ， Python 的 DocString 連在 runtime 都緊身相隨。這些緊附在物件上的 DocString ，除了可做靜態的說明，也能動態的查閱。在 CPython 本身，也隨著軟體包含 pydoc 這個工具，能將 DocString 抽取出來，並重新格式化後，產生靜態文件。除了 pydoc 之外，也有許多其它功能更強的工具，如 Epydoc ，能產生更美觀的文件，更豐富的圖形。