Warning: Dangling Javadoc comment

Question

Since I updated my Android Studio (2.3.1) and build tools (2.3.1), I\'m getting warning,

Warning: Dangling Javadoc comment

for comme

Answer 1

You are using Javadoc format which starts with /** instead of a block comment format which starts with /* .

To alleviate that warning, always start your comments inside the methods with /* not /**.

Answer 2

Just replace "Dangling Javadoc Comment" with block comment.

Answer 3

To me it seems like the right place for this comment is alongside method getFormattedName() because your comment explains the functionality of that method not the reason you're calling it.

Answer 4

It looks like you are using a Javadoc comment when you call the method setNameText. Javadoc comments are to be inserted above a class declaration, a method declaration, or a field declaration.

If you simply want a comment when calling the method, use the one-line comment: // get formatted name based on {@link FORMAT_NAME}.

Answer 5

You may just turn it off in page "File-Settings-Editor-Inspections-Java-Javadoc issues-Dangling Javadoc comment".

Answer 6

In case it helps someone else, make sure you didn't sneak your JavaDoc between the method/class definition and any annotations you had on that definition.