我想在我的Python模块的文档字符串中添加一些元信息,例如作者,电子邮件,版本.有没有规范的方法呢?我搜索了很长一段时间,但在这里或网上找不到具有明确权限的东西.
PEP 426 - Python软件包2.0的元数据谈论它.它看起来像__author__
,__version__
其他一些被pydoc
(V2.7)认可.此外,还有epydoc
和sphinx-doc
.
是否有标准方法在docstring中包含此类信息?还是作为全局变量?如果是,是否有可接受的关键字/变量名称列表?
例:
#########
# Parts
# <description>
#
"""Helper module for selling car parts on the web.
Author: Sue Baru
EMail: sb@carparts.com
Version: 1.0
"""
Run Code Online (Sandbox Code Playgroud)
更新
这不是一个真正的答案,但我最终使用了__author__
'关键字'而没有别的.通过检入git仓库来完成版本控制.
文本模式下的Emacs将\字符(反斜杠)放在换行的末尾.
我希望没有显示,所以我可以从这样的窗口复制粘贴到另一个窗口,而不会在粘贴的文本中获得\.
我确信有一个简单的解决方案,但我找不到它(既不在线,也不在emacs手册中).最接近的似乎是在线的远端禁用小箭头.
从其中的所有回复和链接中提取,这是我最终用于Mac OS X 10.8.3中包含的emacs(22.1.1).它很棒.再次感谢您的帮助!
;; copy to Mac clipboard (for copying text the wrapped '\' lines
(defun copy-to-mac-clipboard ()
"Copy currently selected region to Mac clipboard (useful for wrapped '\\' lines)"
(interactive)
(if (> (- (region-end) (region-beginning)) 0)
(progn
(shell-command-on-region (region-beginning) (region-end) "pbcopy")
(message "region copied to Mac clipboard (%d chars)" (- (region-end) (region-beginning)))
(if (and transient-mark-mode mark-active)
(deactivate-mark)))
(progn
(message "no region active"))
))
;; put this next to M-w, which is kill-ring-save (copy …
Run Code Online (Sandbox Code Playgroud)