search

joelday / papyrus-lang

📜Advanced language tools for the Papyrus scripting language.
Other
111 stars 19 forks source link

Papyrus-standard multi-line comments not currently recognized for Intellisense tooltips #87

Open FelesNoctis opened 5 years ago

FelesNoctis commented 5 years ago

Describe the bug Using the standard multi-line format ;/ /;, while properly handled by syntax parsing, doesn't appear in Intellisense tooltips for local variables, properties, events, or functions.

To Reproduce Steps to reproduce the behavior:

  1. Create any script object that would produce an Intellisense tooptip on hover.
  2. Add a multi-line comment using ;/ /; above said object.
  3. Hover over object name.

Example Multi-line comment

Suggested Change As mentioned by Scrivener07 in Discord and by Joel in issue https://github.com/joelday/papyrus-lang/issues/82#issuecomment-512383211, the current AST may not be robust enough at this time. However, if and when a custom tokenizer/parser is created, this should likely be handled in the same way as Documentation Comments { }, but within the current Single-Line ; section of the Intellisense tooltip instead.

Related Papyrus Documentation Creation Kit: Script_File_Structure#Comments

Possible Related Issues

82

83

joelday commented 1 year ago

@nikitalita Ideally, we'll want to have comments parsed as structured trivia that can be associated with a given symbol. No need to parse anything on the inside.