RMCreative.ru - Блог Голосов: 1 Адрес блога: http://rmcreative.ru/feed/ Добавлен: 2008-06-12 21:34:00 блограйдером ZaiSL

Когда стоит писать комментарии в коде

2015-01-10 18:29:34 (читать в оригинале)

Бытует мнение, что писать комментарии к коду не нужно. Пошло оно, скорее всего, от высказывания одного из отцов программирования — Брайана Кернигана: «Don’t comment bad code, rewrite it». Как всегда, находятся фанатики, которые странно воспринимают авторитетные высказывания и никогда не пишут комментарии принципиально. Это неправильно.

Прежде всего, следует отметить, что документацию к классам и методам надо стараться писать всегда. Она рассказывает, для чего вообще нужен класс или метод и как его использовать.

Что касается непосредственно комментариев в коде, в большинстве случаев они действительно не нужны. Определённо не стоит комментировать каждую строчку метода, описывая словами, какую переменную мы присваиваем на этот раз.

Но есть и случаи, когда комментарии необходимы, а именно кода код делает что-то неочевидное и без комментария не ясно почему и зачем. Именно о таком коде говорит Керниган. Если такой код можно переписать, стоит этим заняться вместо закрепления нелогичности комментариями.

Бывает, что переписать нелогичный код нельзя. Например, при разработке под Android частенько приходится делать совершенно нелогичные на первый взгляд штуки для того, чтобы починить приложение под одной конкретной моделью телефона, которая почему-то работает не так, как описано в официальной документации. В этом случае комментарии в коде оправданы полностью. Без них ваши же коллеги просто удалят «ненужные» строчки, удостоверившись, что на их телефонах всё и без них работает как надо.

---

2014

2014-12-26 21:05:53 (читать в оригинале)

Итак, новый год в очередной раз приближается. Поздравляю с наступающим всех читателей. Год вышел интересный. Много всего случилось как глобально, так и в нашем программистском мире. О глобальном все и так знают, а вот о программистском и личном вспомню.

PHP

• HHVM окончательно вырос. Теперь он может запускать почти весь PHP-код. В том числе Yii 2.0. Мало того, что это даёт нам бесплатную производительность, так ещё и подстегнуло Zend к переписыванию движка PHP. В следующем году нас ждёт гонка движков. phpng, который по плану станет основой следующей версии PHP, обещает быть очень интересным.
• Вышел PHP 5.6, о чём я забыл написать в блог, но писал про RC1.
• Composer сильно набрал обороты. Дело идёт к релизу.

Не совсем PHP, но:

• HTML5 официально обзавёлся спецификацией.
• markdown обзавёлся спецификацией, Carsten из команды Yii выпустил свой парсер markdown.

Yii

Мы выпустили Yii 2.0 после трёх лет работы над ним. Похоже, усилия были не напрасны. Отзывы приятные, критика тоже. Самому нравится. Первый минорный релиз 2.0.1 показал, что фатальных ошибок мы не сделали.

Вышли книги о Yii:

• Yii Project Blueprints.
• Web Application Development with Yii 2 and PHP.
• Yii 2 For Beginners.
• The Yii Book.

Начал писать о переходе с Yii 1.1 на Yii 2.0:

• С Yii 1.1 на Yii 2.0, часть 1: PHP.
• С Yii 1.1 на Yii 2.0, часть 2: Composer.

Тема, как оказалось, очень популярная. В новом году буду писать об этом ещё.

Yii 1.1 мы также не забросили. Вышли исправление безопасности 1.1.15 и полноценный релиз 1.1.16.

Ну и на закуску, запустил с Цвигун Вадимом YiiFeed.

Выступления

В этом году выступал на четырёх конференциях:

• РИТ++, Москва.
• UWDC, Челябинск.
• DevConf, Москва.
• РИФ Воронеж.

По многочисленным просьбам выложил исходники всех своих свежих слайдов.

Кроме того, записался в подкасте и провёл свой первый мастер-класс. Мастер класс прошёл не идеально, но в целом положительно. Сделал выводы.

Инструменты

• Поднял VPN.
• Познакомился с обёрткой для git для работы с GitHub. Отличная штука.
• Сделал свой набор для веб-разработки под Windows.

По сравнению с софтом 2013 произошли некоторые изменения:

• Перебрался на Windows 8.1. Выкинул за ненадобностью DisplayFusion.
• В поездках всё так же использую Macbook Air.
• Перебрался с Chrome на новую Opera.

В остальном изменений нет. Всё так же люблю IDE JetBrains, ConEmu и Total Commander.

Опубликовал пару общих статей

• Хорошие программисты и сложность.
• OpenSource-им PHP код.

В черновиках есть ещё.

Работа

Работаю, как и в прошлом году, над замечательным проектом Stay.com, но теперь, в основном, занимаюсь приложением под Android. Именно поэтому в блоге начали появляться про него заметки:

• Android: поймать back в EditText.
• Android: быстрый удобный эмулятор.
• Android, фрагмент в фрагменте и startActivityForResult.
• Android: обрабатываем нажатие back в фрагментах.

Разрабатывать под Android, как оказалось, бывает интересней, чем верстать под IE 6.

Жизнь

• Мне стукнуло 30. Благодаря любимой жене Жене, в день рождения я научился стоять на сноуборде.
• Дочка растёт. Попробовали походить на английский. В итоге она говорит на нём чище, чем на родном. Родной надо подтягивать :)
• Если вдруг придётся поменять профессию, теперь запросто смогу быть прорабом.
• Страны за этот год: Италия, Греция, Голландия, Германия, Китай, Малазия, Сингапур.
• Российские города: Челябинск, Москва, Екатеринбург, Губкин и много чего из воронежской области.

Ещё раз с наступающим! Пусть новый год будет лучше.

---

YiiFeed

2014-12-26 20:32:47 (читать в оригинале)

Запустили YiiFeed. Проект выдаёт премодерируемую выжимку новостей о фреймворке Yii на английском. Ленту можно читать через RSS или в браузере, в том числе мобильном. После регистрации каждый может предлагать свои новости.

Вживую посмотреть проект можно по адресу http://yiifeed.com/.

Если он пока не открывается, можно прописать в свой hosts 82.196.4.167 yiifeed.com.

Идея появилась давно. В рунете Yii отлично представлен, а в англоязычном интернете с этим проблема. Всё очень разрозненно и нет единого источника качественной дополнительной информации.

Из закромов эту самую идею помог вытащить Цвигун Вадим, который в конце ноября написал мне в почту и попросился в подмастерья. За месяц мы спланировали всё в Trello, накодили и развернули.

Так как проект некоммерческий и скрывать в нём нечего, код был немного причёсан и выложен в открытый доступ на GitHub. Критика в виде issue и pull request очень приветствуется.

В планах тегирование записей, поиск по тегу (как в этом блоге), RSS по тегу, голосование и комментарии.

---

Закончена первая редакция The Yii Book

2014-12-26 14:16:19 (читать в оригинале)

Профессиональный писатель Larry Ullman сообщил о завершении работ по первой редакции «The Yii Book», книге о Yii 1.1. Он собирается начать работать над второй редакцией, которая будет про Yii 2.0, сразу после праздников. Согласно прикидкам, книга может быть готова уже через 6 месяцев.

Все обновления и редакции «The Yii Book» бесплатны для тех, кто купит книгу до 21 декабря 2016.

---

Yii 1.1.16

2014-12-22 15:09:08 (читать в оригинале)

Вышел релиз 1.1.16 PHP-фреймворка Yii. В него вошло более 120 улучшений и исправлений.

Yii 1.1 официально перешёл в режим поддержки. Обновления 1.1 ещё будут, но не стоит ждать каких-либо новых возможностей или больших изменений в будущем. В данный момент мы активно разрабатываем и поддерживаем Yii 2.0.

Полный анонс читайте на хабре