home *** CD-ROM | disk | FTP | other *** search
/ Visual Basic Source Code / Visual Basic Source Code.iso / vbsource / codetree / codetree.txt < prev    next >
Encoding:
Text File  |  1997-10-07  |  4.2 KB  |  97 lines
  1. About CodeTree
  2.  
  3.  
  4.  
  5. CodeTree is an enhanced project browser for Visual Basic 5. 
  6.  
  7. It allows you to browse not only the categories and files 
  8.  
  9. (like the built in project window), but the individual 
  10.  
  11. functions as well. You Simply expand the tree and click 
  12.  
  13. on the function (or property, global, etc.) you would like 
  14.  
  15. to work on. CodeTree opens the file and positions the window 
  16.  
  17. to that function automatically.
  18.  
  19.  
  20.  
  21. CodeTree presents projects in a tree view, much like the 
  22.  
  23. built-in project window, but extends the functionality to 
  24.  
  25. create a browser that is somewhat like Visual C++.
  26.  
  27.  
  28.  
  29. CodeTree also has a limited ability to detect that a given 
  30.  
  31. function calls other functions in its body. This provides a 
  32.  
  33. quick (static) call tree so that you can browse to all related 
  34.  
  35. functions when you are working. If you have a large project, 
  36.  
  37. or very long functions, please be patient. It sometimes takes 
  38.  
  39. a while to figure out all the called items. CodeTree does run 
  40.  
  41. in its own thread, however, and you can work in the rest of 
  42.  
  43. VB while it is searching.
  44.  
  45.  
  46.  
  47. CodeTree has the single feature that no VB user should be 
  48.  
  49. without, FindAll. When in the VB code window editing, simply 
  50.  
  51. highlight a string that you are looking for and select Find 
  52.  
  53. All from the Right-Mouse context menu. The answer will be 
  54.  
  55. presented in a list of Project.Module with line number. Clicking 
  56.  
  57. a row in the list will take you to that location in code!
  58.  
  59.  
  60.  
  61.  
  62.  
  63. Instructions
  64.  
  65.  
  66.  
  67. After activating Code Tree, select it from the Add-In menu. A view 
  68.  
  69. will be presented in a dockable window. Expand and explore your 
  70.  
  71. project. Component level items (form, module, class, etc.) can be 
  72.  
  73. filtered to exclude items with the right-mouse context menu. 
  74.  
  75. Clicking a component or member (property, variable, method, etc.) 
  76.  
  77. will take you directly to that item.
  78.  
  79.  
  80.  
  81. Individual functions can be scanned for other methods and variables 
  82.  
  83. that they reference. With the right mouse menu, select Show Calls 
  84.  
  85. on a member. Be patient, it can take a small amount of time (10-30 
  86.  
  87. sec.) to scan a decent size projects (20-30 forms, 4-5k lines), 
  88.  
  89. depending on the total number of variables and functions. Only 
  90.  
  91. module level items are scanned for. The intent of this function 
  92.  
  93. is navigational, allowing you to quickly see all items you are 
  94.  
  95. calling and go to them. At this time, CodeTree does not resolve 
  96.  
  97. to the object level. In simple terms if you have a really generic 
  98.  
  99. method name like Enabled, you will see it multiple times in the 
  100.  
  101. CodeTree (once for each object with and Enabled method), it doesn't 
  102.  
  103. make any effort to figure out what object class it applies to.
  104.  
  105.  
  106.  
  107. The Find All is the simplest and most useful feature. Select text 
  108.  
  109. in the VB Code Window, and pick Find All on the right-mouse menu. 
  110.  
  111. There is no status bar currently, but the search tends to be very 
  112.  
  113. fast, even on projects of several thousand lines. 
  114.  
  115.  
  116.  
  117. Revision History
  118.  
  119. 0.6 First Available Release
  120.  
  121. --Reworking of internal components into OCX format
  122.  
  123. --Addition of context menu find all feature
  124.  
  125. --Limited progress bar
  126.  
  127. 0.5 Internal Test Release
  128.  
  129. --Mapping of VBIDE to support extensions
  130.  
  131. --Browser code located in AX document
  132.  
  133.  
  134.  
  135.  
  136.  
  137. License
  138.  
  139.  
  140.  
  141. This version of CodeTree is free to all users of VB 5. Please take 
  142.  
  143. the time to email me at wballard@clubnet.net with the subject line 
  144.  
  145. CodeTree so that I can provide you with information on enhancements.
  146.  
  147.  
  148.  
  149. CodeTree is (c)1997 Will Ballard, all rights reserved.
  150.  
  151.  
  152.  
  153. Support 
  154.  
  155.  
  156.  
  157. CodeTree is free, so support is limited. However, mail with the 
  158.  
  159. subject line CodeTree will be processed and bug reports and 
  160.  
  161. suggestions for enhancements will be taken seriously.
  162.  
  163.  
  164.  
  165. At this time, fax contact is also available at (310) 796-1981, 
  166.  
  167. sorry, no 800 number! Best to just use email...
  168.  
  169.  
  170.  
  171. Installation Notes
  172.  
  173.  
  174.  
  175. The setup program is designed to bother you as little as possible. 
  176.  
  177. It only asks for an installation directory. Otherwise, it will 
  178.  
  179. register the codetree.dll and put the proper entry in the vbaddin.ini 
  180.  
  181. file to connect it to you VB5 GUI.
  182.  
  183.  
  184.  
  185. If, however, you do not file CodeTree in you Add-in Manager:
  186.  
  187. 1. Register codetree.dll with regsvr32.exe
  188.  
  189. 2. Add CodeTree.Connect=0 to your vbaddin.ini file
  190.  
  191.  
  192.  
  193.