Skip to content

Instantly share code, notes, and snippets.

@eddsteel

eddsteel/post.md

Last active June 17, 2017 04:55
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save eddsteel/c8f04bbf63fe194b6b00b2956802baf5 to your computer and use it in GitHub Desktop.
Save eddsteel/c8f04bbf63fe194b6b00b2956802baf5 to your computer and use it in GitHub Desktop.
Download ZIP
Links for forum post
Raw
post.md

  • ensime - "Scaladoc comments are indented according to the Scaladoc style guide".

  • vim-scala refers to "the indentation standard as recommended for Scaladoc comments" and links to the guide.

  • Intellij apparently uses "formatting for ScalaDoc2" in its UI.

  • scalafmt has two options for indenting scaladoc: "ScalaDoc" and "JavaDoc".

In addition Twitter, Databricks and Spark style guides all refer to "ScalaDoc style", as does my employer's. Others don't mention it specifically but begin their guides "where unspecified, refer to the official guide". Oops, which one?

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