Code Reading Tool

Http://blog.huang-wei.com/2011/04/27/read-source-tool/

 

DoProgramStaff, every day to the display lineCode
Especially when a piece of code you have never written or read is put in front of you, NI will feel as tired as it is.
None of these are enough. Nima didn't even have a comment !!! Document! Yes !!
The young brother's mind has suffered countless damages in a lot of code ~

In fact, when you read the code, especially the C/C ++ code
Class Structure, inheritance, function calling, and so on, all rely on your own mind and bad pen to remember the words, sooner or later crazy
I hope to help you with my experience and habits.

1. vs
as a code engineer for C/C ++ in win, VS is a powerful tool that cannot be missed.
added the visual assist x plug-in to provide good support for code coloring and smart prompts
viemu plugin, meets various niche requirements of VI/Vim code workers
the selection of this IDE is not detailed. There are also some advantages of netbeans and eclipse.
but these are from the coding perspective. This article is intended to find some methods to facilitate reading and understanding the code.

depends on the various Shortcut Keys provided by the VAX plug-in
for example, ALT + gcan jump quickly in definition and description, and the original F12 can do the same thing, but it is not strong enough
you can view the shortcut keys on the official website.
however, the vs viewing class inheritance function is too weak.

it is still a bit difficult to read the code by relying solely on vs
if you are pursuing keyboard operations, you can use the combination of VIM + ctags. Here is also an article about the related plug-ins
however, these are all editors, which cannot meet larger reading needs.

2. Source insight
This is not a free software, but we are unaware of all kinds of attacks against the Chinese language on the Internet.

This tool can display the Declaration definition and reference at the cursor click, and you can easily jump back to the original place after viewing the search result set
Such a tool is a real code reader.

3. doxygen
Doxygen is a tool for compiling software reference documents.
It can analyze code and comments and automatically generate documents. Many open source libraries also use this software to generate API documents.
Its advantage is that it is convenient to observe the inheritance and aggregation relationships of file structures, classes, and struct. The output result can be HTML, PDF, or CHM, and there is a simple GUI front-end
To generate these legends, you also need to install graphviz.


Combined with insight, I personally think it is easy to understand the framework and specific implementation.
Here is a simple installation and usage introduction.
This is a bit unpleasant, that is, he will generate a certain size of documents, friends who are sensitive to hard disk space should be cautious

4. Rational Rose
Generally, reading the above Code is enough, and the installation package is not large.
However, to form a more powerful and professional UML class diagram, you must have a big killer like Rational Rose.
This article describes how to perform code analysis.

If you are passing by, you can continue to introduce some tools and read them.Source codeExperience
There is a long way to go and continue reading the code ......