Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Suggest using @property tag in KDoc instead of putting comment before property in constructor #302

Closed
petertrr opened this issue Sep 17, 2020 · 3 comments · Fixed by #332 or #559
Closed
Assignees
Labels
enhancement New feature or request

Comments

@petertrr
Copy link
Member

petertrr commented Sep 17, 2020

class CliArgument @JsonCreator internal constructor(
        // short argument representation like -h
        @param:JsonProperty("shortName") private val shortName: String
)

should be

/**
 * @property shortName short argument representation like -h
 */
class CliArgument @JsonCreator internal constructor(
        @param:JsonProperty("shortName") private val shortName: String
)
@petertrr petertrr added the enhancement New feature or request label Sep 17, 2020
@petertrr
Copy link
Member Author

Also I think now we don't check documentation on accessible fields declared as constructor parameter at all.

@kentr0w kentr0w self-assigned this Sep 24, 2020
@petertrr
Copy link
Member Author

We also can have a customizable switch to suggest to replace KDoc on properties and use @property tag instead.

@orchestr7
Copy link
Member

Not added to a codestyle guide. Need to add it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
3 participants