IDE中的可视化文档

时间:2013-07-24 12:53:13

标签: eclipse-plugin coding-style ide documentation

我经常对IDE(现在的Eclipse)中的文本重载感到沮丧。我发现自己用大块的空格分隔我的方法,然后后悔当我需要通过扫描代码找到一些东西时。

我认为效果很好的是GrepCode way查看源代码。有谁知道在代码编辑器中是否已经实现了这样的功能?更具体地说,我希望能够拥有漂亮,格式化和丰富多彩的文档(最好是可折叠的)来帮助我阅读我的代码。它甚至可以嵌入设计图像。

2 个答案:

答案 0 :(得分:0)

“文本重载”正是像Mylyn之类的插件确实存在的原因。

  

Mylyn的以任务为中心的界面可以减少信息过载并简化多任务处理。

     

Mylyn使任务成为IDE的第一部分,集成了ALM工具的丰富和离线编辑,并监控您的编程活动,以创建一个“任务上下文”,专注于您的工作区并自动将所有相关工件链接到任务处 - 手。
  通过减少信息过载,促进多任务处理和简化专业知识共享,您可以轻松获取所需信息并提高工作效率。

splash

另外,你可add to your project WikiText,支持Markdown(见WikiText FAQ及其User Guide

答案 1 :(得分:0)

为了更好地管理大量代码,您可能需要重新考虑这些:

  • 使用Eclipse Mylyn,因为它会隐藏您不能使用的代码。
  • 打开Windows - >首选项,在首选项对话框中键入“折叠” 并检查,默认情况下哪些编辑器应提供更多折叠 向你隐瞒不相关的事情。
  • 看看Java浏览 Eclipse的观点。它源于旧的Smalltalk代码浏览 用户界面,意味着更容易管理(但不能编辑) Java代码。
  • 如果您在视觉上使用代码(并记住其布局而不是结构),您可能会发现Crazy Outline view非常有帮助。它提供了文本的飞机布局视图。

如果您问题的更重要方面是如何更轻松地查看您为代码编写的文档,请查看:

  • 确保JavaDoc视图和Declaraction视图一直打开并可见,以显示Javadoc和光标所指向的声明。确保实际提供JavaDoc注释,以此开始。
  • Eclipse Code Recommenders项目有advanced documentation views,它基本上显示了常见Eclipse代码的数据挖掘结果。您可以获得该工具的公司内部(商业)版本,因此它会建议代码完成,因为您的项目中的其他代码已经编写。