leigh/neogen
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
bryant-the-coder
2022-01-23 20:12:45 +08:00
parent 7e7fbc4ff2
commit 62700b9fea
1 changed files with 49 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files

74
README.md
View File

@@ -5,19 +5,23 @@
[![Neovim](https://img.shields.io/badge/Neovim%200.5+-green.svg?style=for-the-badge&logo=neovim)](https://neovim.io) [![Neovim](https://img.shields.io/badge/Neovim%200.5+-green.svg?style=for-the-badge&logo=neovim)](https://neovim.io)
[![Lua](https://img.shields.io/badge/Lua-blue.svg?style=for-the-badge&logo=lua)](http://www.lua.org) [![Lua](https://img.shields.io/badge/Lua-blue.svg?style=for-the-badge&logo=lua)](http://www.lua.org)
</div> </div>
# Table Of Contents # Table Of Contents
* [Features](#features) - [Neogen - Your Annotation Toolkit](#neogen---your-annotation-toolkit)
* [Requirements](#requirements) - [Table Of Contents](#table-of-contents)
* [Installation](#installation) - [Features](#features)
* [Usage](#usage) - [Requirements](#requirements)
* [Configuration](#configuration) - [Installation](#installation)
* [Supported Languages](#supported-languages) - [Usage](#usage)
* [Adding Languages](#adding-languages) - [Cycle between annotations](#cycle-between-annotations)
* [GIFS](#gifs) - [Configuration](#configuration)
- [Supported Languages](#supported-languages)
- [Adding Languages](#adding-languages)
- [GIFS](#gifs)
- [Credits](#credits)
## Features ## Features
@@ -187,34 +191,32 @@ Check out `:h neogen-advanced_configurations` for more information !
There is a list of supported languages and fields, with their annotation style There is a list of supported languages and fields, with their annotation style
| Language | Annotation conventions | Supported fields | Supported annotation types | Languages | Annotation Conventions | Supported annotation types |
|---|---|---|---| | --------------- | ---------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- |
| lua | | | `func`, `class`, `type`, `file` | | lua | [Emmylua](https://emmylua.github.io/) (`"emmylua"`) | `@func`, `@class`, `@type`, `@file` |
| | [Emmylua](https://emmylua.github.io/) (`"emmylua"`) | `@param`, `@varargs`, `@return`, `@class`, `@type`, `@module` | | | [Ldoc](https://stevedonovan.github.io/ldoc/manual/doc.md.html) (`"ldoc"`) | |
| | [Ldoc](https://stevedonovan.github.io/ldoc/manual/doc.md.html) (`"ldoc"`) | `@param`, `@varargs`, `@return`, `@class`, `@type` | | --------------- | ---------------------------------------------------------------------------------------------------------------------- | |
| python | | | `func`, `class`, `file`, `type` | | python | [Google docstrings](https://google.github.io/styleguide/pyguide.html) (`"google_docstrings"`) | |
| | [Google docstrings](https://google.github.io/styleguide/pyguide.html) (`"google_docstrings"`) | `Args`, `Attributes`, `Returns` | | | [Numpydoc](https://numpydoc.readthedocs.io/en/latest/format.html) (`"numpydoc"`) | |
| | [Numpydoc](https://numpydoc.readthedocs.io/en/latest/format.html) (`"numpydoc"`)| `Arguments`, `Attributes`, `Returns`| | --------------- | ---------------------------------------------------------------------------------------------------------------------- | |
| javascript | | | `func`, `class`, `file`, `type`| | javascript | [JSDoc](https://jsdoc.app) (`"jsdoc"`) | |
| | [JSDoc](https://jsdoc.app) (`"jsdoc"`) | `@param`, `@returns`, `@class`, `@classdesc`, `@module`, `@type`| | typescript | | |
| typescript | | | `func`, `class`, `file`, `type` | | --------------- | ---------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- |
| | [JSDoc](https://jsdoc.app) (`"jsdoc"`) | `@param`, `@returns`, `@class`, `@classdesc`, `@type`, `@module`| | c | [Doxygen](https://www.doxygen.nl/manual/commands.html) (`"doxygen"`) | `@func`, `@file` |
| c | | | `func`, `file`| | --------------- | ---------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- |
| | [Doxygen](https://www.doxygen.nl/manual/commands.html) (`"doxygen"`) | `@param`, `@return`, `@brief`, `@file`| | cpp | [Doxygen](https://www.doxygen.nl/manual/commands.html) (`"doxygen"`) | `@func`, `@file`, `@class` |
| cpp | | | `func`, `file`, `class`| | --------------- | ---------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- |
| | [Doxygen](https://www.doxygen.nl/manual/commands.html) (`"doxygen"`) | `@param`, `@return`, `@tparam`, `@brief`, `@file`, `@class`| | go | [GoDoc](https://go.dev/blog/godoc) (`"godoc"`) | `@func`, `@type` |
| go | | | `func`, `type` | | --------------- | ---------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ |
| | [Godoc](https://go.dev/blog/godoc) (`"godoc"`) | | | java | [Javadoc](https://docs.oracle.com/javase/1.5.0/docs/tooldocs/windows/javadoc.html#documentationcomments) (`"javadoc`) | `@func`, `@class` |
| java | | | `func`, `class` | | --------------- | ---------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- |
| | [Javadoc](https://docs.oracle.com/javase/1.5.0/docs/tooldocs/windows/javadoc.html#documentationcomments) (`"javadoc"`) | `@param`, `@return`, `@throws`| | rust | [RustDoc](https://doc.rust-lang.org/rustdoc/what-is-rustdoc.html) (`"rustdoc"`) | `@func`, `@file`, `@class` |
| rust | | | `func`, `file`, `class` |
| | [Rustdoc](https://doc.rust-lang.org/rustdoc/what-is-rustdoc.html) (`"rustdoc"`) | |
| | [Alternative](https://stackoverflow.com/questions/30009650/how-do-you-document-function-arguments) (`"alternative"`) | | | | [Alternative](https://stackoverflow.com/questions/30009650/how-do-you-document-function-arguments) (`"alternative"`) | |
| csharp | | | `func`, `file`, `class`| | --------------- | ---------------------------------------------------------------------------------------------------------------------- | |
| | [Xmldoc](https://docs.microsoft.com/fr-fr/dotnet/csharp/language-reference/xmldoc/) (`"xmldoc"`) | `<summary>`, `<param>`,`<returns>`| | csharp | [Xmldoc](https://docs.microsoft.com/fr-fr/dotnet/csharp/language-reference/xmldoc/) (`"xmldoc"`) | |
| | [Doxygen](https://www.doxygen.nl/manual/commands.html) (`"doxygen"`) | `@param`, `@return`, `@brief`| | | [Doxygen](https://www.doxygen.nl/manual/commands.html) (`"doxygen"`) | |
| php | | | `func`, `type`, `class` | | --------------- | ---------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- |
| | [Php-doc](https://docs.phpdoc.org/3.0/guide/references/phpdoc/index.html) (`"phpdoc"`) | `@var`, `@param`, `@return` | | php | [Ph-doc](https://docs.phpdoc.org/3.0/guide/references/phpdoc/index.html) (`"phpdoc"`) | `@func`, `@type`, `@class` |
## Adding Languages ## Adding Languages