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:17:48 +08:00
parent 62700b9fea
commit 37dd32b025
1 changed files with 9 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@@ -195,27 +195,27 @@ There is a list of supported languages and fields, with their annotation style
| --------------- | ---------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- | | --------------- | ---------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- |
| lua | [Emmylua](https://emmylua.github.io/) (`"emmylua"`) | `@func`, `@class`, `@type`, `@file` | | lua | [Emmylua](https://emmylua.github.io/) (`"emmylua"`) | `@func`, `@class`, `@type`, `@file` |
| | [Ldoc](https://stevedonovan.github.io/ldoc/manual/doc.md.html) (`"ldoc"`) | | | | [Ldoc](https://stevedonovan.github.io/ldoc/manual/doc.md.html) (`"ldoc"`) | |
| --------------- | ---------------------------------------------------------------------------------------------------------------------- | | | | | |
| python | [Google docstrings](https://google.github.io/styleguide/pyguide.html) (`"google_docstrings"`) | | | python | [Google docstrings](https://google.github.io/styleguide/pyguide.html) (`"google_docstrings"`) | |
| | [Numpydoc](https://numpydoc.readthedocs.io/en/latest/format.html) (`"numpydoc"`) | | | | [Numpydoc](https://numpydoc.readthedocs.io/en/latest/format.html) (`"numpydoc"`) | |
| --------------- | ---------------------------------------------------------------------------------------------------------------------- | | | | | |
| javascript | [JSDoc](https://jsdoc.app) (`"jsdoc"`) | | | javascript | [JSDoc](https://jsdoc.app) (`"jsdoc"`) | |
| typescript | | | | typescript | | |
| --------------- | ---------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- | | | | |
| c | [Doxygen](https://www.doxygen.nl/manual/commands.html) (`"doxygen"`) | `@func`, `@file` | | c | [Doxygen](https://www.doxygen.nl/manual/commands.html) (`"doxygen"`) | `@func`, `@file` |
| --------------- | ---------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- | | | | |
| cpp | [Doxygen](https://www.doxygen.nl/manual/commands.html) (`"doxygen"`) | `@func`, `@file`, `@class` | | cpp | [Doxygen](https://www.doxygen.nl/manual/commands.html) (`"doxygen"`) | `@func`, `@file`, `@class` |
| --------------- | ---------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- | | | | |
| go | [GoDoc](https://go.dev/blog/godoc) (`"godoc"`) | `@func`, `@type` | | go | [GoDoc](https://go.dev/blog/godoc) (`"godoc"`) | `@func`, `@type` |
| --------------- | ---------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | | | | |
| java | [Javadoc](https://docs.oracle.com/javase/1.5.0/docs/tooldocs/windows/javadoc.html#documentationcomments) (`"javadoc`) | `@func`, `@class` | | java | [Javadoc](https://docs.oracle.com/javase/1.5.0/docs/tooldocs/windows/javadoc.html#documentationcomments) (`"javadoc`) | `@func`, `@class` |
| --------------- | ---------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- | | | | |
| rust | [RustDoc](https://doc.rust-lang.org/rustdoc/what-is-rustdoc.html) (`"rustdoc"`) | `@func`, `@file`, `@class` | | rust | [RustDoc](https://doc.rust-lang.org/rustdoc/what-is-rustdoc.html) (`"rustdoc"`) | `@func`, `@file`, `@class` |
| | [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 | [Xmldoc](https://docs.microsoft.com/fr-fr/dotnet/csharp/language-reference/xmldoc/) (`"xmldoc"`) | | | csharp | [Xmldoc](https://docs.microsoft.com/fr-fr/dotnet/csharp/language-reference/xmldoc/) (`"xmldoc"`) | |
| | [Doxygen](https://www.doxygen.nl/manual/commands.html) (`"doxygen"`) | | | | [Doxygen](https://www.doxygen.nl/manual/commands.html) (`"doxygen"`) | |
| --------------- | ---------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- | | | | |
| php | [Ph-doc](https://docs.phpdoc.org/3.0/guide/references/phpdoc/index.html) (`"phpdoc"`) | `@func`, `@type`, `@class` | | php | [Ph-doc](https://docs.phpdoc.org/3.0/guide/references/phpdoc/index.html) (`"phpdoc"`) | `@func`, `@type`, `@class` |
## Adding Languages ## Adding Languages