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

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

Люди также опасаются переименований из страха возражений со стороны других разработчиков. Мы не разделяем эти опасения, а изменение имен (в лучшую сторону) вызывает у нас только благодарность. Большей частью мы не запоминаем имена классов и методов. Современные инструменты берут на себя подобные мелочи, а мы следим за тем, чтобы программный код читался как абзацы и предложения или хотя бы как таблицы и структуры данных (предложение не всегда является лучшим способом отображения данных). Возможно, своими переименованиями — как и любыми другими усовершенствованиями кода — вы кого-то удивите. Пусть это вас не останавливает.

Последуйте этим правилам и посмотрите, не станет ли ваш код более удобочитаемым. Если вы занимаетесь сопровождением чужого кода, попробуйте решить проблемы средствами рефакторинга. Это даст немедленный результат и продолжит приносить плоды в долгосрочной перспективе.

Глава 3. Функции

На заре эпохи программирования системы строились из программ, функций и подпрограмм. До наших дней дожили только функции. Они образуют первый уровень структуризации в любой программе, и их грамотная запись является основной темой этой главы.

Рассмотрим код в листинге 3.1. В FitNesse[10] трудно найти длинную функцию, но после некоторых поисков мне это все же удалось. Функция не только длинна, но она содержит повторяющиеся фрагменты кода, множество загадочных строк, а также странные и неочевидные типы данных и функции API. Попробуйте разобраться в ней за три минуты. Посмотрим, что вам удастся понять.

Листинг 3.1. HtmlUtil.java (FitNesse 20070619)

public static String testableHtml(

  PageData pageData,

  boolean includeSuiteSetup

) throws Exception {

  WikiPage wikiPage = pageData.getWikiPage();

  StringBuffer buffer = new StringBuffer();

  if (pageData.hasAttribute("Test")) {

    if (includeSuiteSetup) {

      WikiPage suiteSetup =

        PageCrawlerImpl.getInheritedPage(

                SuiteResponder.SUITE_SETUP_NAME, wikiPage

        );

      if (suiteSetup != null) {

        WikiPagePath pagePath =

          suiteSetup.getPageCrawler().getFullPath(suiteSetup);

        String pagePathName = PathParser.render(pagePath);

        buffer.append("!include -setup .")

              .append(pagePathName)

              .append("\n");

      }

    }

    WikiPage setup =

      PageCrawlerImpl.getInheritedPage("SetUp", wikiPage);

    if (setup != null) {

      WikiPagePath setupPath =

        wikiPage.getPageCrawler().getFullPath(setup);

      String setupPathName = PathParser.render(setupPath);"

      buffer.append("!include -setup .")

            .append(setupPathName)

            .append("\n");

    }

  }

  buffer.append(pageData.getContent());

  if (pageData.hasAttribute("Test")) {

    WikiPage teardown =

      PageCrawlerImpl.getInheritedPage("TearDown", wikiPage);

    if (teardown != null) {

      WikiPagePath tearDownPath =

        wikiPage.getPageCrawler().getFullPath(teardown);

      String tearDownPathName = PathParser.render(tearDownPath);

      buffer.append("\n")

            .append("!include -teardown .")

            .append(tearDownPathName)

            .append("\n");

    }

    if (includeSuiteSetup) {

      WikiPage suiteTeardown =

        PageCrawlerImpl.getInheritedPage(

                SuiteResponder.SUITE_TEARDOWN_NAME,

                wikiPage

        );

      if (suiteTeardown != null) {

        WikiPagePath pagePath =

          suiteTeardown.getPageCrawler().getFullPath (suiteTeardown);

        String pagePathName = PathParser.render(pagePath);