Code Style Guide¶

In Verilog Translator project we use Google Java Style Guide and How to Write Doc Comments for the Javadoc Tool recommendations for Javadoc comments.

Also we start every Java class with the following license agreement (substitute "2019" with current year):

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

The Javadoc header for class should contain the following author data:

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