Project

General

Profile

Task #3982

[code] Рекомендации по коду

Added by Alexander Kamkin over 6 years ago. Updated over 5 years ago.

Status:
Closed
Priority:
High
Category:
-
Target version:
Start date:
03/01/2013
Due date:
% Done:

0%

Estimated time:
Detected in build:
svn
Published in build:

Description

  1. tabs-> spaces (1 tab = 4 spaces).
  2. заголовок файла - лицензия Apache 2.0 (см. ниже).
  3. в каждом файле указывать автора кода (см. ниже).
  4. javadoc-комментарии (in English) ко всем public-методам (это можно делать постепенно).
/*
 * Copyright 2013 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.
 */
/**
 * Class description.
 *
 * @author <a href="mailto:ivanov@mail.ru">Ivan Ivanov</a>
 */

Files

History

#1

Updated by Alexander Kamkin over 6 years ago

  • Description updated (diff)
#2

Updated by Sergey Smolov over 6 years ago

  • Status changed from New to Open

1,2,3 - выполнено.

#3

Updated by Sergey Smolov over 5 years ago

  • File javaguide.pdf added

Далее придерживаемся конвенции по оформлению кода Google Java Style (http://google-styleguide.googlecode.com/svn/trunk/javaguide.html).

Документ с описанием прикреплен.

#4

Updated by Sergey Smolov over 5 years ago

  • File deleted (javaguide.pdf)
#7

Updated by Sergey Smolov over 5 years ago

Необходимо срочно выполнить пункт 4 исходной задачи.

#8

Updated by Sergey Smolov over 5 years ago

  • Priority changed from Normal to High
#9

Updated by Igor Melnichenko over 5 years ago

Я бы, кстати, добавил к гугловским рекомендациям ещё две:
1) избегать сокращений, не являющихся широко распространёнными, в названиях классов и методов;
2) делать информативными названия аргументов методов.

#10

Updated by Alexander Kamkin over 5 years ago

  • Subject changed from Рекомендации по коду to [code] Рекомендации по коду
  • Target version set to 0.1
#11

Updated by Sergey Smolov over 5 years ago

  • Status changed from Open to Resolved
  • Assignee changed from Sergey Smolov to Alexander Kamkin

Создал маленькое руководство по форматированию кода тут: http://forge.ispras.ru/projects/retrascope/wiki/Code_Style_Guide

Туда же положил описание Google Java Style и шаблон для Eclipse.

Тикет можно закрывать.

#12

Updated by Alexander Kamkin over 5 years ago

  • Status changed from Resolved to Closed

Also available in: Atom PDF