PTT數位生活區 / Python

[問題] 註解用什麼語法比較好?

看板Python作者 (Victor)時間16年前 (2008/10/20 17:05), 編輯推噓2(2推 0噓 7→)
留言9則, 7人參與, 最新討論串1/1
請問Python在註解時用什麼語法比較好? 我在這之前都用類似doxygen那種格式 @param xxx: xxxxxxx @return : ..... @raise : ..... 當要生成文件卻發現好像很多工具都不支援這種格式= = 我看目前都是以reStructuredText為主流的樣子 python需要註解到param這麼詳細嗎= =? 還是說已經夠清楚了，所以不用? 用reStructuredText雖然很強大 但是如果想要統一param或return用某種方式表達就辦不到 因為被reStructuredText的格式寫死了 但用單純文字描述又有點覺得太亂 所以應該要怎樣寫比較好 囧? -- 易記學 程式設計教學 http://ez2learn.com/ 易記學 程式設計討論區 http://forum.ez2learn.com VICTOR's 個人Blog http://blog.ez2learn.com/ 財報分析王 http://victorlin.serveftp.org/stock/ -- ※ 發信站: 批踢踢實業坊(ptt.cc) ◆ From: 118.170.95.224
推
10/20 17:31, , 1F
真是太強了 期待教寫網頁的課程^^
10/20 17:31, 1F
→
10/20 20:11, , 2F
有不少 project 用 epydoc
10/20 20:11, 2F
→
10/20 20:19, , 3F
我用目前試著Apydia產生文件
10/20 20:19, 3F
→
10/20 20:19, , 4F
可是問題不在產生的工具 而是文件的語法
10/20 20:19, 4F
推
10/20 22:26, , 5F
我也有這個問題@@
10/20 22:26, 5F
→
10/20 23:08, , 6F
http://tinyurl.com/6n3trt 可參考django的doc style
10/20 23:08, 6F
→
10/20 23:09, , 7F
主要也是ReST
10/20 23:09, 7F
→
10/21 02:13, , 8F
你用的是 epytext; format provided by epydoc
10/21 02:13, 8F
→
11/04 15:08, , 9F
sphinx is the ultimate doc tool!
11/04 15:08, 9F
‣ 更多 StubbornLin 的文章
文章代碼(AID): #18_4dNRD (Python)
Python 近期熱門文章
更多 近期熱門文章 >>
PTT數位生活區 即時熱門文章
更多 即時熱門文章 >>
‣ 更多 StubbornLin 的文章
文章代碼(AID): #18_4dNRD (Python)