Кириллица в комментариях к коду модулей

Главные вкладки

Аватар пользователя zhylik zhylik 17 февраля 2009 в 1:27

Вопрос в большей мере относится к разработчикам: используете ли вы кириллицу в комментариях при написании кода модулей или такой подход является непростительным? Речь, разумеется, о коде не для drupal.org

/**
 * Строит таблицу отношений между словами в фразе.
 *
 * Для каждой пары слов (в т.ч. и обратной пары) в исходном массиве:
 * - вычисляется расстояние (в словах);
 * - фиксируется порядок расположения слов относительно друг друга;
 * - в зависимости от порядка вычисляется контрольное расстояние между словами.
 *
 * param $words
 *   Линейный массив слов исследуемой фразы. Порядок слов в исходной фразе должен
 *   соответствовать порядку расположения слов в данном массиве.
 *
 * return
 *   Линейный массив, ключи которого являются идентификаторами пар слов, а
 *   значения - линейными массивами, содержащими следующие поля:
 *   - RELATIONS_DISTANCE - расстояние между словами в паре;
 *   - RELATIONS_ORDER - булевый пареметр, принимающий значение TRUE в случае когда второе
 *     слово из пары находится после первого;
 *   - RELATIONS_XDISTANCE - контрольное расстяние.
 *
 * TODO:
 *  - Адекватная работа при отсутсвии слова в индексе.
 */

function words_relations($words) {
  // Индексная таблица слов.
  global $index;

  // Таблица отношений.
  $relations = array();

  // Количество слов в массиве.
  $words_count = count($words);

  // Цикл перебора слов.
  for ($first_word=0; $first_word<$words_count; $first_word++) {
    for ($second_word=0; $second_word<$words_count; $second_word++) {
      if ($first_word != $second_word) {
        // Получение индекса первого и второго слов, вычисление идентификатора пары.
        $first_word_index = array_search($words[$first_word], $index);
        $second_word_index = array_search($words[$second_word], $index);
        $relation_id = $first_word_index * 10000 + $second_word_index;

        // Вычисление расстояния, фиксирование порядка.
        $relations[$relation_id][RELATIONS_DISTANCE] = abs($first_word - $second_word);
        $relations[$relation_id][RELATIONS_ORDER] = ($first_word < $second_word) ? TRUE : FALSE;

        // Вычисление контрольного расстояния. Если в фразе первое слово расположено после
        // второго, то к обычному расстоянию между словами прибавляется фиксированное
        // значение ADJ_INCORRECT_ORDER. В случае корректного расположения слов,
        // обычное расстояние уменьшается на поправку ADJ_CORRECT_ORDER.
        $relations[$relation_id][RELATIONS_XDISTANCE] = $relations[$relation_id][RELATIONS_DISTANCE];
        $relations[$relation_id][RELATIONS_XDISTANCE] += $relations[$relation_id][RELATIONS_ORDER] == TRUE ? ADJ_CORRECT_ORDER : ADJ_INCORRECT_ORDER;
      }
    }
  }

  return $relations;
}

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

Я пишу по-русски, т.к. считаю, что наличие русских комментов лучше, чем отсутствие оных вообще или набросанных на кривом английском.

Комментарии

Аватар пользователя axel axel 17 февраля 2009 в 2:54

Я думаю комментарии могут быть на любом языке понятном самому разработчику и тем кто будет смотреть код после него. Если это код рунетовского сайта, то и комментарии на русском уместны.

Аватар пользователя glu2006 glu2006 17 февраля 2009 в 9:41

Пишу комменты в коде на кривом английском, потом есть кому выровнять ))).
Считаю что русские комменты уместны в коде 1С и больше вроде как и негде их постить.
А уже если надо хелп, то собственно ничего не мешает выделить в Вашем модуле страничку с описанием завернутым в функцию t(); или же к примеру readme-ru.txt с описанием всех ваших действий и функций на любом языке.

Аватар пользователя zhylik zhylik 17 февраля 2009 в 17:01

theСанитар wrote:
А вот что это у вас за модуль такой интересный? ;-)

да, вобщем на досуге пытаюсь сделать штуку, вычисляющую процент цитируемости искомой фразы в заданных текстах (описанных опр. образом), в зависимости от близости, порядка слов и т.д.) это одна из функций) бред вобщем) просто первое попавшееся и более-менее красиво выглядевшее взял)