addons/TagHighlight/README.md

   1 # TagHighlight
   2
   3 TagHighlight is a plugin that highlights names of classes, variables, types etc in source code in Vim.  This makes it quicker and easier to spot errors in your code.  By using exuberant ctags and parsing the output, the typedefs, #defines, enumerated names etc are all clearly highlighted in different colours.  As standard, it supports the following languages (but it's very easy to add more):
   4
   5 * C/C++ (most of the testing has been with these)
   6 * C#
   7 * Java
   8 * Javascript
   9 * Matlab (functions only; may require custom ctags version)
  10 * Perl
  11 * PHP
  12 * Python
  13 * Ruby
  14 * Scala
  15 * Fortran
  16 * Go (if your version of ctags supports it)
  17 * VHDL (if your version of ctags supports it)
  18
  19 Adding more languages is extremely simple.
  20
  21 To show the benefit of this plugin, there are some screenshots and a more detailed description at the following website:
  22
  23   [http://www.cgtk.co.uk/taghighlight][Website]
  24
  25 Installation instructions are available here:
  26
  27   [http://www.cgtk.co.uk/taghighlight/install][InstallGuide]
  28
  29 The source is managed in Mercurial and is available on [bitbucket][Bitbucket].
  30
  31 Detailed documentation can be found in [doc/TagHighlight.txt][Documentation].
  32
  33 [Website]: http://www.cgtk.co.uk/taghighlight
  34 [InstallGuide]: http://www.cgtk.co.uk/taghighlight/install
  35 [Bitbucket]: https://bitbucket.org/abudden/taghighlight
  36 [Documentation]: https://bitbucket.org/abudden/taghighlight/src/default/doc/TagHighlight.txt