Formatting for method descriptions is not preserved #5785
Replies: 2 comments
-
Hi @bobalicious - Thanks for submitting this and including the screenshots - very helpful. Is your objection that the extra whitespace is removed? (extra lines & indents). |
Beta Was this translation helpful? Give feedback.
-
Thanks for the response. You are correct, in essence. My objection is the fact that there are no options for providing some form of formatting. Having had a look around, the convention in other languages appears to be to either:
I would personally prefer the whitespace to be preserved (as this means the doc comments are readable when viewed inline, in the code itself), though I'd be happy with HTML tags or some other markup, as long as it's possible to have some formatting options. |
Beta Was this translation helpful? Give feedback.
-
Summary
When description comments are added to Apex methods, the resulting tool-tip does not preserve formatting, nor does it appear to provide any mechanism for stating that certain formatting should apply.
Steps To Reproduce:
Expected result
Formatting of the documentation comment to be preserved. Or options exist for stating the formatting required.
Actual result
Formatting of the documentation comment is not preserved.
Additional information
VS Code Version: Version 1.30.0 (1.30.0)
SFDX CLI Version: sfdx-cli/7.69.0-1101929cd1 darwin-x64 node-v12.18.3
OS and version: macOs Catalina 10.15.2
Beta Was this translation helpful? Give feedback.
All reactions