Code Style Guide » History » Revision 13
Revision 12 (Sergey Smolov, 07/26/2019 01:44 PM) → Revision 13/14 (Sergey Smolov, 01/27/2020 02:52 PM)
h1. Code Style Guide
In Retrascope project we use "Google Java Style Guide":https://google.github.io/styleguide/javaguide.html and "How to Write Doc Comments for the Javadoc Tool":http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html recommendations for Javadoc comments.
Also we start every Java class with the following license agreement (substitute "2015" with current year):
<pre><code class="java">
/*
* Copyright 2015 ISP RAS (http://www.ispras.ru), UniTESK Lab (http://www.unitesk.com)
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
</code></pre>
and with the following author data:
<pre><code class="java">
/**
* Class description.
*
* @author <a href="mailto:ivanov@mail.ru">Ivan Ivanov</a>
*/
</code></pre>
Also we use Gradle "checkstyle":https://docs.gradle.org/current/userguide/checkstyle_plugin.html plugin in the project build script. To check the coding style, run the following command:
<pre>
$ ./gradlew checkstyleMain checkstyleTest
</pre>