JavaRush/Java блог/Архив info.javarush/Оформление кода

41 уровень

20.01.2016
2809просмотров
11комментариев

Оформление кода

участников

Одну из задач (которая была решена и принята сервером) я реализовал в виде кода (забил * и X-ми чтобы не спойлерить).

/* xxx
1. Считывать строки(параметры) с консоли, пока пользователь не введет пустую строку(Enter).
2. Каждый параметр соответствует имени ***.
Для каждого параметра:
3. Создать объект *** класса ***, который равен *** из getX(String параметр).
4. Вывести на экран toString().
*/

public class Solution
{
    public static void main(String[] args) throws Exception
    {
        //Add your code here
        List al= new ArrayList<>();
        BufferedReader reader = new BufferedReader(new InputStreamReader(System.in));
        String str;
        while(!"".equals(str = reader.readLine())) al.add(str);
        for (int i = 0; i 
Зашедший в гости полузнакомый раскритиковал, что так не пишут (это тебе не C и т.п.).
Не подскажете в чем я не прав (есть какие нормы и общепринятые стандарты) ?
Или использование в одной строчке нескольких конструкций (оно вообще, без промежуточных присваиваний временным переменным, может привести в каких-либо ситуациях к каким-либо возможным последствиям?) - дурной тон?
Основные переменные (al, reader, str) объявлены до их использования (pascal-стиль), так как мне удобнее, всегда знаешь где можешь найти описание переменной с возможным комментарием.
Вспомогательные переменные объявлены в нужной зоне видимости (как переменная цикла i).
Idea не ругается, правда предлагает 2 опции:
Split into declaration and assigment (таки разделить объявление и присваивание) и заключить некоторые участки в блок try.

Как бы Вы правильнее написали код?

Что не так?
Для такой задачи не стоит комментировать каждую строчку.

Комментарии (11)

популярные
новые
старые

Для того, чтобы оставить комментарий Вы должны авторизоваться

Nezhelskiy

Уровень 14

21 января 2016, 13:06

Замечу, что написанный в одну строку блок в режиме отладки будет выполняться целиком и невозможно будет проследить по-шагово, что происходит в цикле, например.

Fry

Уровень 41

21 января 2016, 12:19

www.oracle.com/technetwork/java/codeconventions-150003.pdf

yag0andy

Уровень 41

20 января 2016, 11:07

Вот такое:

for (int i = 0; i <al.size(); i++) System.out.println(XFactory.getX(al.get(i)).toString());

я предпочел бы заменить на:


for (String line : list) {
    System.out.println(XFactory.getX(line).toString());
}

Названия переменных типа «а1» суть зло ))

Joysi

Уровень 41

20 января 2016, 11:36

Спасибо, работа через итератор принимается (Я по привычке все через циклы делаю, надо уже переучиваться ведь не для всех типов можно линейным перебором по индексу работать). Там не a1, там — al (aL от ArrayList — обычно для имен переменных от сложных типов первые символы даю соответствующие типу, чтобы сразу понять чьих она будет).
Вопрос — а зачем обрамлять в {} если один оператор? На случай будущих кодовых вставок в тело цикла? Или распространенные сторонние инструменты анализа кода для будущего рефакторинга не распознают?
Но таким образом ведь мы лишаем себя видеть дополнительную пару строк кода в текущей области окна редактора кода.

И еще вопрос (с точки зрения прекомпиляции и используемой памяти): обе конструкции генерируют одинаковый байт-код и одинаково расходуют память?

//1
System.out.println(XFactory.getX(al.get(i)).toString())
//2
str     = al.get(i);
objMeow = XFactory.getX(str);
System.out.println(objMeow.toString());

yag0andy

Уровень 41

20 января 2016, 11:47

По поводу {}. Дело вкуса. Я иногда обрамляю, иногда нет. В циклах обрамляю. Не обрамляю в таких случаях:


if (needClose) 
    close();

Такое не грех и в одну строку записать. Т.е. когда конструкция крайне проста.

Переменная al и а1. В некоторых шрифтах разницу не заметить. Я вот не заметил.

Такое

while(!"".equals(str = reader.readLine())) al.add(str);

ну тоже не в одну строчку… и покрасивше… Я такое видел в «решениях», но мне не очень нравится.

ИМХО красивее было бы что-то типа:


String buffer;
while (!(buffer = reader.readLine()).equals("")){
    list.add(buffer); 
}

Но, не настаиваю. Тут всё-таки мы в вторгаемся в тему предпочтений, а тут кому как )

yag0andy

Уровень 41

20 января 2016, 11:59


String buffer;
while (!(buffer = reader.readLine()).isEmpty()){
    list.add(buffer); 
}

Нет пределов совершенству

EvIv

Уровень 30

20 января 2016, 14:33

while (!(buffer = reader.readLine()).equals(""))

опасно! а если reader.readLine() вдруг вернет null?
Всегда лучше сравнивать строковую переменную с константой так:

"someConstString".equals(varStr)

, тогда гарантированно не поймаете NullPointerException, так как equals() вызовется на точно существующем объекте «someConstantString»

yag0andy

Уровень 41

20 января 2016, 14:41

Соглашусь. В этом случае и применение isEmpty() не безопасно.

Joysi

Уровень 41

20 января 2016, 15:13

Таки моя конструкция

while(!"".equals(str = reader.readLine())) al.add(str);

имеет больше прав на существование :-)

blacky

Уровень 23

11 апреля 2016, 08:58

Относительно записи нескольких операторов в одну строку (в основном это if, for, while) — есть одно правило, которое мне очень понравилось и смысл его в следующем:
— если результат улучшает общую читабельность кода и меньше 80 символов, то можно записать в одну строку без фигурных скобок;
— если же нужно разместить на нескольких строках, то всегда следует использовать фигурные скобки.

Joysi

Уровень 41

11 апреля 2016, 09:18

Сейчас, через квартал с хвостиком. Я бы переписал свое

while(!"".equals(str = reader.readLine())) al.add(str);

в виде

while(!"".equals(str = reader.readLine()))
    al.add(str);

Из-за отступа сразу видна зависимость оператора (от шапки цикла, условия...)
P.S. Все это субъективно + если работаете в коллективе могут быть наложены и свои правила.