作者StubbornLin (Victor)
看板Python
标题[问题] 注解用什麽语法比较好?
时间Mon Oct 20 17:05:25 2008
请问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
1F：推 pianoboy:真是太强了 期待教写网页的课程^^ 10/20 17:31
2F：→ yjc1:有不少 project 用 epydoc 10/20 20:11
3F：→ StubbornLin:我用目前试着Apydia产生文件 10/20 20:19
4F：→ StubbornLin:可是问题不在产生的工具 而是文件的语法 10/20 20:19
5F：推 bizkit:我也有这个问题@@ 10/20 22:26
7F：→ superGA:主要也是ReST 10/20 23:09
8F：→ yungyuc:你用的是 epytext; format provided by epydoc 10/21 02:13
9F：→ gasolin:sphinx is the ultimate doc tool! 11/04 15:08