Azure / Azure/azure-sdk-tools

[Java APIView] Method signature is incorrectly rendered with inline comment text

Open
#14,938 0 comments 0 reactions 0 assignees View on GitHub
APIView customer-reported Java question
Dominant language
C#
Stars
135
Forks
260
Avg merge
3d 1h
Merged PRs (30d)
143

Description

Bad code snippet:
```java
public static SecretServiceVersion getLatest(// returns V7_6 )
```

What it should do:
APIView should not render a valid Java method signature as if it contains an inline comment inside the parameter list. The text `// returns V7_6` is not a real comment in the source and is misleadingly shown as part of the code snippet due to a parser/rendering issue.

Good code snippet:
```java
public static SecretServiceVersion getLatest() {
return V7_6;
}
```

Contributor guide

Open the contributing guide

Research direction

Start by reproducing the Bad code snippet in the APIView Java parsing and rendering flow, then compare it with the Good snippet. Trace how the method signature is tokenized and displayed; done means the valid signature is rendered without the `// returns V7_6` text.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
devtools
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.