源代码注释工具

时间:2010-05-21 08:16:34

标签: javascript annotations code-analysis

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

我需要了解一些第三方源代码(JavaScript),我不想更改它(添加内联注释)以便

  • 行号可以保持不变(与他人交流),
  • 我可以避免意外更改某些内容和
  • 与作者的评论相比,我的注释更加突出。

通常情况下,我会将整个内容打印出来,但是代码太长了,我需要按照电子邮件分享。如果能做到这样的话,我会很高兴,包括能够在代码中的这些位置之间创建“链接”,甚至可能用线条或箭头在视觉上。

7 个答案:

答案 0 :(得分:14)

如果你经常打印它(如果它更短),为什么不将它打印成PDF然后使用支持评论的PDF查看器,如福昕阅读器? :)

答案 1 :(得分:4)

我会使用电子邮件发表评论,pastebin主持并突出显示电子邮件文本中包含链接的@h@行。
OR
一些代码审核工具(例如codestrickerreviewboard

答案 2 :(得分:2)

您当然可以使用LaTeX及其列表包执行您想要的操作。但如果你还不是LaTeX用户,你可能会觉得这很难走。

答案 3 :(得分:2)

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

答案 4 :(得分:1)

你有困难的要求。我不知道这样的工具。然而,作为更通用的工具,我可以推荐Yui Doc(下载here)。

答案 5 :(得分:1)

我为它构建了一个glamour browser。 (如果花费半天时间建造它不会太多)。

[编辑] Glamour是一个用于在模型上构建浏览器的工具包。该模型将包含文件的各个部分以及您要添加的注释和属性。这将允许您轻松浏览源和注释,以仅选择具有(或不具有)某些属性的部分。有一个video和幻灯片。 Official pageSource

答案 6 :(得分:0)

如何使用google wave with syntaxy(http://wave-samples-gallery.appspot.com/about_app?app_id=14008)bot?