Code Style Guide¶

In Retrascope project we use Google Java Code Style and Oracle recommendations for Javadoc comments.

An Eclipse IDE profile and a PDF description of Google Java Code Style are attached to this document.

Also we start every Java class with the following license agreement:

/*
 * 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.
 */

and with the following author data:

/**
 * Class description.
 *
 * @author <a href="mailto:ivanov@mail.ru">Ivan Ivanov</a>
 */