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

Comment parsing to improve code information #5

Open
guilherme-gm opened this issue May 2, 2019 · 0 comments
Open

Comment parsing to improve code information #5

guilherme-gm opened this issue May 2, 2019 · 0 comments
Labels
enhancement New feature or request

Comments

@guilherme-gm
Copy link
Owner

Implementing some kind of parser on code comments could give usefull information to improve general usage and documentation (e.g. Java/Javadocs).

Some use-cases:

Var documentation

.@itemCount = 10; //< how many apples player should get

so later on, when you use auto-complete, .@itemCount would show "how many apples player should get" on its documentation.

Function / Routine docs

More or less related to: #4

/**
 * @param int number number to format
 * @param str comma symbol to be used
 */
function	script	F_InsertComma	{
   // ...

When using callfunc, signature helper could find out that F_InsertComma receives 2 parameters and their types.

"External" function reference

A feature to give the parser information that a function exists, even though it may not find it. This is usefull when writting a script that uses Hercules' global functions.

//#external F_InsertComma(number: int, comma: str): str
@guilherme-gm guilherme-gm added the enhancement New feature or request label May 2, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant