Adding scaladocs to a Scala function in Sublime Text 2

I’m trying to comment my code more often. Specifically, I’m trying to add useful comments more often. In many cases this requires documenting a function using a scaladoc comment, but I can never remember the syntax, so I created a sublime-text-2 snippet.

Here it is on github

To install: Tools -> Create Snippet -> [paste in the gist] -> save as something.sublime-snippet.


just type ‘docs’ and press tab. Hey presto! Instant documentation.

Enjoy. (I’m sure this already exists, but creating a snippet was a learning exercise too!)

Matthew Rathbone's Picture

Matthew Rathbone

CEO of Beekeeper Data. British. Data Nerd. Lucky husband and father. More about me

Join the discussion