Source Xref 与 JavaDocs 学习理解

简介:

 没找到java相关代码的解释,其实用下面这个php版本解释,也非常不错。

What is SOURCEXref?

SOURCEXref is a developer tool that’s designed to ease the process of working on large PHP projects by making it very fast and easy to browse the code documentation along with the code itself.

It works by scanning a project directory and translating the files it finds into readable cross-referenced HTML, simultaneously utilizing comments in the code to produce documentation to accompany it. The result is a collection of plain HTML files that can be read using any browser, with no supporting software required.

SOURCEXref has very minimal requirements to run; just having a copy of Perl installed is all you need (and the Windows binary supplies that for you). Getting started requires editing two or three lines in the configuration file and running the program.

Features

  • Minimal requirements, minimal setup.
  • No web server required to view output.
  • Cross-references  PHP classes, functions, variables, constants and require/include usage.
  • Extracts phpdoc style documentation from source files.
  • Javascript enhanced output provides:Pretty-prints  PHP files from the browser.
    • Mouse-over information for classes and functions in the source view.
    • Hot-jump to the source of any class/function definition.
    • Instant lookup of classes, functions, constants and tables by name.
    • Search/lookup history.

                                            ——又找到个代码网站:http://www.sourcexref.com/

  说得简练一点儿,就是在浏览器里可以直接向上通过类型、通过调用,跟踪源代码的结构,当然是通过链接来实现

  

  那这个插件和javaDocs是什么关系呢?

  其实很像啦,只不过javaDocs主要是用来展现代码里的各个注释

  

  

1
2
3
4
5
6
至于实现原理上,我在想,
     首先,程序文件按照目录进行存放,这个和网址里的目录概念上可以对应。
     然后,像类名,方法名就可以做出链接了。把包名定义中的 .  切换成 / 向上回溯。
 
又或者基于IDE中的类结构,做个类型表之类的,想不通了。没玩过。
     

  

 

 本文转自二郎三郎博客园博客,原文链接:http://www.cnblogs.com/haore147/p/5498896.html,如需转载请自行联系原作者

相关文章
|
Java
使用ideal 生成JavaDOC文档
使用ideal 生成JavaDOC文档
57 0
|
自然语言处理 Java API
eclipse如何为java项目生成API文档、JavaDoc
eclipse如何为java项目生成API文档、JavaDoc
182 0
|
Java
编译JDK:Javadoc.gmk:344: *** target pattern contains no ‘%‘。 停止
编译JDK:Javadoc.gmk:344: *** target pattern contains no ‘%‘。 停止
151 0
|
Java iOS开发
Mac编译OpenJDK8:configure: error: Xcode 4 is required to build JDK 8, the version found was 10.1config
Mac编译OpenJDK8:configure: error: Xcode 4 is required to build JDK 8, the version found was 10.1config
127 0
|
Java Maven Android开发
IntelliJ IDEA 中看到 classes, sources, javadocs 三种jar的区别和各自的作用
在 intelliJ idea 里面看到 ,Project Structure——》 Libraries ——》 Sources 的路径是红色的 看图会比较好。以guava包为例来说明。 可以看到在这看整个maven项目的依赖时,发现如图的情况,这红色是什么情况,是报错吗?需要处理吗?这3个不同jar都是什么东西,各自有啥作用。
4836 0
|
Android开发
解决bug:在eclipse中导入Android项目时报错: “invalid resource directory name bin/res/crunch”
解决bug:在eclipse中导入Android项目时报错: “invalid resource directory name bin/res/crunch”
524 0
|
缓存 Java Maven
IDEA 告警:Library source does not match the bytecode for class
IDEA 告警:Library source does not match the bytecode for class
974 0
IDEA 告警:Library source does not match the bytecode for class
|
Java Go Maven
Eclipse里调试时遇到Source not found应该怎么办
Eclipse里调试时遇到Source not found应该怎么办
303 0
Eclipse里调试时遇到Source not found应该怎么办