forcedotcom / salesforcedx-vscode

Salesforce Extensions for VS Code
https://developer.salesforce.com/tools/vscode
BSD 3-Clause "New" or "Revised" License
954 stars 406 forks source link

ApexDoc not considered. #4472

Open jefersonchaves opened 2 years ago

jefersonchaves commented 2 years ago

Summary

Salesforce Visual Studio code does not yet support the highlight of parameters. Based on #948 it was mentioned and delivered in my understanding.

Steps To Reproduce:

  1. Create a method
    /**
    * It says hello!
    * @param personNameToGreet The name of the person to say hello!
    */
    private static String sayHelloTo(String personNameToGreet) {
    return 'Hello ' + personNameToGreet + '!';
    }
  2. Highlight the code. image
  3. Check params for documentation. image

Expected result

A highlight of parameter documentation.

Actual result

No documentation.

Additional information

Salesforce Extension Version in VS Code: v55.8.0

SFDX CLI Version: sfdx-cli/7.169.1 darwin-arm64 node-v16.17.0

SFDX CLI Plugins Version:

@oclif/plugin-autocomplete 1.3.0 (core)
@oclif/plugin-commands 2.2.0 (core)
@oclif/plugin-help 5.1.12 (core)
@oclif/plugin-not-found 2.3.1 (core)
@oclif/plugin-plugins 2.1.0 (core)
@oclif/plugin-update 3.0.0 (core)
@oclif/plugin-version 1.1.2 (core)
@oclif/plugin-warn-if-update-available 2.0.4 (core)
@oclif/plugin-which 2.1.0 (core)
@salesforce/sfdx-plugin-lwc-test 1.0.1 (core)
@salesforce/sfdx-scanner 2.13.9
alias 2.1.0 (core)
apex 1.2.0 (core)
auth 2.2.5 (core)
community 2.0.1 (core)
config 1.4.19 (core)
custom-metadata 2.0.0 (core)
data 2.1.2 (core)
generator 2.0.2 (core)
info 2.1.0 (core)
limits 2.0.1 (core)
org 2.2.3 (core)
packaging 1.9.1 (core)
salesforce-alm 54.8.1 (core)
schema 2.1.3 (core)
sfdmu 4.16.3
sfdx-cli 7.169.1 (core)
sfdx-git-delta 5.5.0
signups 1.2.0 (core)
source 2.0.13 (core)
telemetry 2.0.0 (core)
templates 55.1.0 (core)
trust 2.0.4 (core)
user 2.1.2 (core)

OS and version: MacOS 12.5.1 - Monterey

randi274 commented 2 years ago

Hi @jefersonchaves - thanks for digging up that old issue for us! I'm seeing the same as you are. With JS files, we are providing the documentation on hover, but that's not happening with Apex. I'm not sure if it was working previously, as the issue indicated, or not. I'll mark it as a bug since we did indicate the feature had shipped though, and that'll go into our backlog. Thanks for calling that out for us!

Screen Shot 2022-10-03 at 10 53 40 AM Screen Shot 2022-10-03 at 10 53 54 AM
git2gus[bot] commented 2 years ago

This issue has been linked to a new work item: W-11844548

jefersonchaves commented 2 years ago

Thanks a lot @randi274 - It is awesome to hear such a quick feedback. Thank you all for all the hard work (I still remember the days of Eclipse - so, even though there is room for improvement for the current state of Vscode integration is so much better that is hard to quantify but important to highlight).