Source Xref and JavaDocs learning comprehension

Recently Learning MyBatis official documents, see the "Project Document" section has a lot of content has not seen, make a note, understand.

Did not find the Java related Code interpretation, in fact, with the following version of PHP interpretation, but also very good.

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, can are read using any browser, with no supporting software require D.

Sourcexref have very minimal requirements to run; Just has a copy of Perl installed is all you need (and the Windows binary supplies so for you). Getting started requires editing 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, Varia Bles, constants and require/include usage.

• Extracts phpdoc style documentation from source files.

• Javascript Enhanced output provides:pretty-prints  p Hp 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.

--and find a code site: http://www.sourcexref.com/

　　To be concise, that is, in the browser can be directly up through the type, through the call, tracking the structure of the source code, of course, through the link to achieve .

　　

What is the relationship between this plugin and Javadocs?

It's pretty much the same, but Javadocs is mostly used to show the various annotations in the code .

　　

　　

As for the principle of implementation, I was thinking,    first of all, the program files are stored according to the directory, this and the URL in the directory concept can correspond.    then, like the class name, the method name can make a link. The package name is defined in the.  Switch to/up backtracking. Or, based on the class structure in the IDE, making a type table or something like that doesn't make sense. I've never played.     

　　

　　

Source Xref and JavaDocs learning comprehension