Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

How can annotate api documentation?Support multiple languages #429

Open
jicvi opened this issue Jun 13, 2020 · 1 comment
Open

How can annotate api documentation?Support multiple languages #429

jicvi opened this issue Jun 13, 2020 · 1 comment

Comments

@jicvi
Copy link

jicvi commented Jun 13, 2020

How can annotate api documentation?
like this vim-jsdoc。
Expect javascript:

/**
  * foo.
  * foo.
  *  Author :  name
  * mail :    .........
  *  Created Time :  ...........
  *  
  * @param {} arg1
  * @param {} arg2
  */
function* foo(arg1, arg2) { }

Expect python or ruby:

"""
  " foo.
  " Author :  name
  "mail :    .........
  " Created Time :  ...........
  " 
  "  @param {} arg1
  "  @param {} arg2
  """
function* foo(arg1, arg2) { }

Expect lua:

--[[
  " foo.
  " Author :  name
  " mail :    .........
  "  Created Time :  ...........
  "  
  "  @param {} arg1
  "  @param {} arg2
  --]
function* foo(arg1, arg2) { }

Expect c or java or c++ ........

@alerque
Copy link
Member

alerque commented Jun 13, 2020

Most/all doc strings are the "sexy" comment format, already supported by this plugin for many language. The exception that comes to mind first is probably Rust which has a different format which is typically covered by other Rust tooling and isn't needed in this plugin.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants