Чистый код. Создание, анализ и рефакторинг - [29]

Например, следующий фрагмент я обнаружил в FitNesse. В самом деле, комментарий здесь бы пригодился. Но автор то ли торопился, то ли не придал особого значения тому, что он пишет. Его бормотание оставляет читателя в недоумении:

public void loadProperties()
{
  try
  {
      String propertiesPath = propertiesLocation + "/" + PROPERTIES_FILE;
      FileInputStream propertiesStream = new FileInputStream(propertiesPath);
      loadedProperties.load(propertiesStream);
  }
  catch(IOException e)
  {
    // Если нет файла свойств, загружаются настройки по умолчанию
  }
}

Что означает комментарий в блоке catch? Очевидно, он что-то означал для автора, но для читателя этот смысл не доходит. Видимо, если мы получаем IOException, это означает, что файл свойств отсутствует; в этом случае должны загружаться все настройки по умолчанию. Но кто загружает эти настройки? Были ли они загружены перед вызовом loadProperties.load? Или вызов loadProperties.load перехватывает исключение, загружает настройки по умолчанию, а затем передает исключение нам, чтобы мы могли его проигнорировать? Или loadProperties.load загружает настройки по умолчанию до того, как вы попытались загрузить файл? Автор пытался успокоить себя относительно того факта, что он оставил блок catch пустым? Или — и это самая пугающая возможность — автор хотел напомнить себе, что позднее нужно вернуться и написать код загрузки настроек по умолчанию?

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

Избыточные комментарии

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

Листинг 4.1. waitForClose

// Вспомогательный метод; возвращает управление, когда значение this.closed истинно.
// Инициирует исключение при достижении тайм-аута.
public synchronized void waitForClose(final long timeoutMillis)
throws Exception
{
  if(!closed)
  {
    wait(timeoutMillis);
    if(!closed)
      throw new Exception("MockResponseSender could not be closed");
  }
}

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

А теперь рассмотрим легион бесполезных, избыточных комментариев Javadoc из листинга 4.2, позаимствованных из Tomcat. Эти комментарии только загромождают код и скрывают его смысл. Никакой пользы для документирования от них нет. Что еще хуже, я привел только несколько начальных комментариев — в этом модуле их намного больше.

Листинг 4.2. ContainerBase.java (Tomcat)

public abstract class ContainerBase
  implements Container, Lifecycle, Pipeline,
  MBeanRegistration, Serializable {

  /**
   * Задержка процессора для этого компонента.
   */
  protected int backgroundProcessorDelay = -1;

  /**
   * Поддержка событий жизненного цикла для этого компонента.
   */
  protected LifecycleSupport lifecycle =
    new LifecycleSupport(this);

  /**
   * Слушатели контейнерных событий для этого контейнера.
   */
  protected ArrayList listeners = new ArrayList();

  /**
   * Реализация загрузчика, связанная с контейнером.
   */
  protected Loader loader = null;

  /**
   * Реализация журнального компонента, связанная с контейнером.
   */
  protected Log logger = null;

  /**
   * Имя журнального компонента.
   */
  protected String logName = null;

  /**
   * Реализация менеджера, связанная с контейнером.
   */
  protected Manager manager = null;

  /**
   * Кластер, связанный с контейнером.
   */
  protected Cluster cluster = null;

  /**
   * Удобочитаемое имя контейнера.
   */
  protected String name = null;
  /**
   * Родительский контейнер, по отношению к которому
   * данный контейнер является дочерним.
   */
  protected Container parent = null;

  /**
   * Загрузчик родительского класса, задаваемый при назначении загрузчика.
   */
  protected ClassLoader parentClassLoader = null;

  /**
   * Объект Pipeline, связанный с данным контейнером.
   */
  protected Pipeline pipeline = new StandardPipeline(this);

  /**
   * Объект Realm, связанный с контейнером.
   */
  protected Realm realm = null;

  /**
   * Объект ресурсов DirContext, связанный с контейнером
   */
  protected DirContext resources = null;

Недостоверные комментарии

Иногда с самыми лучшими намерениями программист делает в комментариях заявления, неточные и не соответствующие истине. Еще раз взгляните на совершенно лишний, но при этом слегка вводящий в заблуждение комментарий из листинга 4.1.

А вы нашли, в чем этот комментарий обманывает читателя? Метод не возвращает управление, когда значение this.closed становится истинным. Он возвращает управление, если значение this.closed истинно; в противном случае метод ожидает истечения тайм-аута, а затем инициирует исключение, если значение this.closed так и не стало истинным.