Skip to content

Inline comments for params of methods/classes #11342

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

Open
BarkingBad opened this issue Feb 8, 2021 · 0 comments
Open

Inline comments for params of methods/classes #11342

BarkingBad opened this issue Feb 8, 2021 · 0 comments

Comments

@BarkingBad
Copy link
Contributor

@julienrf proposed to have inline comments for params of methods/classes in #10526

What do you think of documenting parameters directly, rather than in the scaladoc comment attached to their method/class definition?
E.g.:

/** A Foo */
case class Foo(
  /** An x */
  x: Int
)

def bar(
  /** A Bah */
  bah: Bah
)(using
  /** Context Quux */
  Quux
): Unit

I think this would be useful outside of using parameters, by the way.

We could reconsider it in the future

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants