2010-05-21 114 views
23

我正在寻找一个可以注释源代码的工具。源代码注释工具

我有一些第三方的源代码(JavaScript的)我需要理解,我不想改变它(添加内部注释),这样

  • 行号可以保持不变(与他人沟通),
  • 我可以避免意外更改的东西和
  • 我的注释比作者的评论更加突出。

通常情况下,我会将所有东西打印出来,但代码太长,我需要通过电子邮件分享它。如果能够做到这一点,包括能够在代码中的这些位置之间创建“链接”,甚至可能在视觉上用线条或箭头,我都会很棒。

+3

一个有趣的问题... – nickf 2010-05-24 14:10:10

回答

14

如果您通常会打印它(如果它较短),为什么不将它打印到PDF然后使用支持注释的PDF查看器,如福昕阅读器? :)

+0

+1:肯定是比我更好的通用答案。 – 2010-05-21 08:39:52

+0

这听起来像一个平易近人的方式。我在文字处理器中考虑与注释类似的东西。 – RoToRa 2010-05-21 08:46:09

+0

我使用Open Office来评论代码并将其保留为这种格式用于审阅目的。 – Shivam 2010-05-26 18:25:33

1

您有困难的要求。我不知道这样的工具。尽管如此,作为一个更通用的工具,我可以推荐Yui Doc(下载here)。

+0

不幸的是,我不认为正常的文件建立发电机将帮助我很多。我所使用的代码大量使用了匿名函数来实现闭包,高阶函数和currying。 – RoToRa 2010-05-21 08:45:01

2

你当然可以做你想要的LaTeX和它的列表包。但是如果你还不是LaTeX的用户,你可能会认为这是一个艰难的路要走。

1

我会为它建立一个glamour browser。 (如果花费半天建设它不会太多)。

Glamour是一个在模型上构建浏览器的工具包。这里的模型将包含文件的各个部分以及您想要添加的注释和属性。这将允许您轻松浏览源代码和注释,以仅选择具有(或不具有)特定属性的部分。有一个video和幻灯片。 Official page,Source

+1

什么是魅力应该是?我浏览过几次网页,只是不明白... – RoToRa 2010-05-29 11:35:15

2

启动一个github项目并在那里发布代码,github包含注释能力OOB。

+0

注释功能非常好。我一开始非常怀疑,但现在我确信他们工作得很好。 – 2010-05-30 20:05:01

+2

你可以给一个链接描述这个功能吗?我似乎无法在github网站上找到任何东西。 – RoToRa 2010-05-31 07:50:36