2009年8月17日星期一

Code-Illuminated for Python

最近在关注Bespin的时候发现了一个有意思的小东西,Code-Illuminated项目。Mozilla Ubiquity项目组为了更好的注释代码而创建了它,Atul Varma在Beautifully Documented Code之中详述了它的前生今世。

我第一眼就喜欢上了这个小玩意儿,因为我觉得他比之doxygen等传统代码文档生成工具有以下几个优点:
  1. 形式简洁:左注释右代码,一目了然
  2. 表现力丰富:使用CroeleWiki作为注释格式,注释中的代码量更少,表达能力更强
  3. 免编译:纯web表现,无需额外工具,速度也非常快

兴奋了一下之后我的第二个念头是,它能用在Python上面么?貌似不行,现在它只能处理Javascript。不过没关系,毛爷爷说“自己动手,丰衣足食”,开源的好处就在这里。CI的逻辑很简单,小改一下就好了(中文注释也没有问题)。


正如Atul的博文中所说,这东西还有很大的潜力可以挖掘。Bespin作为一个在线的源代码编辑应用程序,已经集成了Mercurial的一些版本控制命令。如果Bespin再集成上这么一个在线代码生成和查看的组件将会如何?嘿嘿……

没有评论:

发表评论