meta-view

View metadata from .NET assemblies

View assembly metadata, and it's documentation from a C# project, generated by Visual Studio IDE (not VSCode).

P.S. This package mimics the MetadataSource feature from Visual Studio IDE

💾 Usage

🔍 1. Open a C# file

Make sure the .cs file is a valid source file under a C# project.

🔍 2. View assembly metadata!

Navigate to a symbol you want to search, then call M-x meta-view-at-point.

🔨 Configurations

meta-view-active-modes

Major modes that allow to view metadata source, default is csharp-mode.

meta-view-after-insert-hook

Hooks run after buffer is inserted to display view, default is nil.

For example, display line numbers for metadata buffer. (on left)

(add-hook 'meta-view-after-insert-hook
          (lambda ()
            (display-line-numbers-mode 1)))

Display Line Numbers	Advance

You can fold all comments by your favorite folding package. (on right)

meta-view-display-function

Function call to display reference data, default to #'switch-to-buffer.

🛠️ Contribute

If you would like to contribute to this project, you may either clone and make pull requests to this repository. Or you can clone the project and establish your own branch of this tool. Any methods are welcome!

🔬 Development

To run the test locally, you will need the following tools:

• Eask
• Make (optional)

Install all dependencies and development dependencies:

$ eask install-deps --dev

To test the package's installation:

$ eask package
$ eask install

To test compilation:

$ eask compile

🪧 The following steps are optional, but we recommend you follow these lint results!

The built-in checkdoc linter:

$ eask lint checkdoc

The standard package linter:

$ eask lint package

📝 P.S. For more information, find the Eask manual at https://emacs-eask.github.io/.

⚜️ License

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.

See LICENSE for details.