Project

General

Profile

Code Style Guide » History » Version 6

Sergey Smolov, 03/25/2019 04:27 PM

1 1 Sergey Smolov
h1. Code Style Guide
2
3 6 Sergey Smolov
In Retrascope project we use Google Java Code Style (https://google.github.io/styleguide/javaguide.html) and Oracle recommendations for Javadoc comments (http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html).
4 1 Sergey Smolov
5 3 Sergey Smolov
An Eclipse IDE profile and a PDF description of Google Java Code Style are attached to this document.
6 1 Sergey Smolov
7
Also we start every Java class with the following license agreement:
8
9 5 Sergey Smolov
<pre><code class="java">
10 1 Sergey Smolov
/*
11 4 Andrei Tatarnikov
 * Copyright 2015 ISP RAS (http://www.ispras.ru), UniTESK Lab (http://www.unitesk.com)
12 1 Sergey Smolov
 *
13
 * Licensed under the Apache License, Version 2.0 (the "License");
14
 * you may not use this file except in compliance with the License.
15
 * You may obtain a copy of the License at
16
 *
17
 *     http://www.apache.org/licenses/LICENSE-2.0
18
 *
19
 * Unless required by applicable law or agreed to in writing, software
20
 * distributed under the License is distributed on an "AS IS" BASIS,
21
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
22
 * See the License for the specific language governing permissions and
23
 * limitations under the License.
24
 */
25 5 Sergey Smolov
</code></pre>
26 1 Sergey Smolov
27
and with the following author data:
28
29 5 Sergey Smolov
<pre><code class="java">
30 1 Sergey Smolov
/**
31
 * Class description.
32
 *
33
 * @author <a href="mailto:ivanov@mail.ru">Ivan Ivanov</a>
34
 */
35 5 Sergey Smolov
</code></pre>