diff --git a/akka-docs/rst/dev/developer-guidelines.rst b/akka-docs/rst/dev/developer-guidelines.rst index c8acfe33cc..35064807c0 100644 --- a/akka-docs/rst/dev/developer-guidelines.rst +++ b/akka-docs/rst/dev/developer-guidelines.rst @@ -10,7 +10,18 @@ Developer Guidelines Code Style ---------- -The Akka code style follows the `Scala Style Guide `_ . +The Akka code style follows the `Scala Style Guide `_ . The only exception is the +style of block comments: + +.. code-block:: scala + + /** + * Style mandated by "Scala Style Guide" + */ + + /** + * Style adopted in the Akka codebase + */ Akka is using ``Scalariform`` to format the source code as part of the build. So just hack away and then run ``sbt compile`` and it will reformat the code according to Akka standards.