{"draftJsState":{"blocks":[{"data":{"image":{"id":"644ae33e01c9812cc7896215"}},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"","type":"atomic:image","key":"bm3ok"},{"data":{},"depth":0,"entityRanges":[{"key":0,"length":22,"offset":10}],"inlineStyleRanges":[],"text":"Источник: Nuances of Programming","type":"unstyled","key":"celv"},{"data":{},"depth":0,"entityRanges":[{"key":1,"length":140,"offset":0}],"inlineStyleRanges":[{"length":53,"offset":0,"style":"BOLD"}],"text":"Курс SkillFactory для новичков IT-специалист с нуля. Определите подходящую вам профессию в IT, освойте ее с нуля и устройтесь в IT-компанию.","type":"unstyled","key":"1hpg0"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Людям свойственно забывать ранее написанный текст. А к программированию и коду это относится в первую очередь.","type":"unstyled","key":"f4go5"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Обсудим сначала, чем разборчиво составленный код лучше сокращенно написанного. Затем рассмотрим стратегии, помогающие писать чистый код:","type":"unstyled","key":"d8ict"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"выбор названий переменных, классов и функций;","type":"unordered-list-item","key":"4jng5"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"функции помощника;","type":"unordered-list-item","key":"234n3"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"кодовые комментарии;","type":"unordered-list-item","key":"77lh8"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"перечисления, словари, запечатанные классы и пр.;","type":"unordered-list-item","key":"56vbk"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"формирование пакетов и наименование.","type":"unordered-list-item","key":"evkd2"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[{"length":29,"offset":0,"style":"BOLD"}],"text":"Насколько полезны сокращения?","type":"header-three","key":"qtlo"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Будучи младшим разработчиком, я предпочитал использовать для идентификаторов (часто это любой фрагмент кода) аббревиатуры и сокращенные имена.","type":"unstyled","key":"34ort"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Логика здесь простая. Чем меньше времени потратишь, тем быстрее выполнишь работу. Но справедливо это лишь в следующих случаях.","type":"unstyled","key":"furtr"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Ни мне, ни кому-то другому никогда не придется читать и исправлять этот код.","type":"unordered-list-item","key":"dp566"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Я хорошо запоминаю используемые в функциях переменные.","type":"unordered-list-item","key":"ff6h9"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Мне не приходится заниматься созданием достаточно сложного для восприятия кода.","type":"unordered-list-item","key":"3i9cg"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Я смогу переименовать нелепые или непонятные названия функций, классов и свойств внешней библиотеки в более осмысленные.","type":"unordered-list-item","key":"esv3k"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Далеко не всегда сокращенный код экономит время. К тому же в современных IDE для этого есть полезная функция автозавершения кода.","type":"unstyled","key":"7vr7t"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Вы можете соглашаться не со всеми утверждениями. Используйте из далее описанного лишь то, что удобно для вас.","type":"unstyled","key":"5cmtn"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Теперь рассмотрим методики упрощения кода. Примеры будут даны на Kotlin. Но их смысл применим к большинству платформ и языков.","type":"unstyled","key":"168ak"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[{"length":49,"offset":0,"style":"BOLD"}],"text":"Как выбирать имена классов, переменных и функций?","type":"header-three","key":"53mao"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Я рассматриваю две важные особенности при выборе имен объектов программного обеспечения (ПО), которые включают:","type":"unstyled","key":"7gjci"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"классы, структуры, объекты;","type":"unordered-list-item","key":"eqlnn"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"переменные, значения, ссылки, указатели;","type":"unordered-list-item","key":"6d59l"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"функции, методы, алгоритмы, команды;","type":"unordered-list-item","key":"7aa7n"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"интерфейсы, протоколы, абстракции.","type":"unordered-list-item","key":"cuvg9"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"По сути, это все, что использует программист.","type":"unstyled","key":"13b87"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[{"length":39,"offset":0,"style":"BOLD"}],"text":"Насколько описательным должно быть имя?","type":"header-three","key":"2lta7"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[{"length":56,"offset":38,"style":"BOLD"}],"text":"Присваиваемые объектам ПО имена должны выражать их предназначение, но без лишних подробностей.","type":"unstyled","key":"dod3h"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Детали процесса обычно не нужны. Важен контекст объекта, особенно на уровне функций и переменных. Степень детализации зависит от конкретного контекста.","type":"unstyled","key":"2mjml"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Рассмотрим три примера:","type":"unstyled","key":"ou81"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"getFormattedDate(date: String) : String;","type":"ordered-list-item","key":"12buk"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"getYYYYMMDDFormattedDate(date: String) : String;","type":"ordered-list-item","key":"abtr1"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"getYYYYMMDDFormattedDateFromIso8601Format(date: String) : String.","type":"ordered-list-item","key":"fs5rs"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Приложение, над которым я работал при написании статьи, часто требовало прямого и обратного преобразования дат в разные форматы.","type":"unstyled","key":"2ns3s"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"В этом контексте я всегда использую что-то подобное примеру 3. Пример 1 очень неоднозначен для этого случая.","type":"unstyled","key":"400ap"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Другим вариантом может быть изменение имени параметра в примере 2 на что-то вроде iso8601Date. Но при этом я придерживаюсь единого непротиворечивого подхода к той или иной кодовой базе. Не стесняйтесь экспериментировать с подходящими вариантами.","type":"unstyled","key":"34hac"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[{"length":73,"offset":0,"style":"ITALIC"}],"text":"Добавляйте необходимую информацию, чтобы устранять любую двусмысленность.","type":"blockquote","key":"br0m7"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[{"length":48,"offset":96,"style":"BOLD"}],"text":"Пример 1 подойдет для одноразовой программы, которая единожды преобразует один формат в другой. Добавления излишней информации следует избегать.","type":"unstyled","key":"5dagr"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[{"length":49,"offset":0,"style":"BOLD"}],"text":"Расширенная функциональность усложняет именование","type":"header-three","key":"2tnpt"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Чаще всего (хотя и не всегда) проблемы с тем, чтобы выбрать имя, возникают для объектов ПО с расширенными и несвязанными концептуально возможностями.","type":"unstyled","key":"1vuns"},{"data":{},"depth":0,"entityRanges":[{"key":2,"length":8,"offset":70}],"inlineStyleRanges":[],"text":"Степень концептуальной взаимосвязи объектов ПО называется связностью (cohesion).","type":"unstyled","key":"5im20"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[{"length":89,"offset":0,"style":"BOLD"}],"text":"Степень связности объектов ПО должна сообщать о возможностях их группировки и разделения.","type":"unstyled","key":"1mvvu"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Рассмотрим на примере этот процесс с разных точек зрения. Предположим, есть четыре объекта ПО:","type":"unstyled","key":"arbe7"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"StoreUserInCloud;","type":"ordered-list-item","key":"afmja"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"StoreUserOnDisk;","type":"ordered-list-item","key":"6jn4e"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"StoreMessage;","type":"ordered-list-item","key":"484c3"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"EditUserUI.","type":"ordered-list-item","key":"71ls4"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Во первых, эти объекты связаны с данными реального мира. С этой точки зрения мы видим, что StoreUserInCloud, StoreUserOnDisk, а также EditUserUI используют одинаковую модель информации: User.","type":"unstyled","key":"hfk6"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Однако следует учитывать и другую точку зрения, особенно при разработке программ GUI. Каждая такая программа может быть разбита на три основных уровня:","type":"unstyled","key":"f1j6n"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"пользовательский интерфейс (обычно “View”);","type":"unordered-list-item","key":"8lcmu"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"логика (обычно относится к таким объектам, как контроллеры и представление);","type":"unordered-list-item","key":"fi5if"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"модель (хранилище данных и доступ к нему или само состояние в зависимости от вашего определения).","type":"unordered-list-item","key":"5u81a"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Имейте в виду, что этот трехуровневый подход является обобщением, которого часто недостаточно. В любом случае с этой точки зрения StoreMessage имеет больше общего с другими объектами хранения, чем EditUserUI.","type":"unstyled","key":"9f2ou"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Применяя разделение, вы поймете, что оно работает, если выбирать имена программных объектов станет проще.","type":"unstyled","key":"7vaib"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[{"length":40,"offset":0,"style":"BOLD"}],"text":"Как использовать вспомогательные функции","type":"header-three","key":"1baor"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Вспомогательные функции (helper functions), особенно в сочетании с подходящими для них именами, могут значительно улучшить читаемость кода. Эти функции также дают возможность применять основной принцип архитектуры ПО — разделение ответственностей (separation of concerns).","type":"unstyled","key":"el223"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[{"length":26,"offset":0,"style":"BOLD"}],"text":"Создаем головоломку Sudoku","type":"header-three","key":"7af77"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Рассмотрим практический пример расширенного использования вспомогательных функций. Попробуйте представить, насколько сложно читать код, где все описано только одной гигантской функцией!","type":"unstyled","key":"2ut95"},{"data":{},"depth":0,"entityRanges":[{"key":3,"length":6,"offset":78}],"inlineStyleRanges":[],"text":"Ранее я работал над большой, но взаимосвязанной частью программы: конструктор Sudoku , который использует графовые структуры данных и алгоритмы (Graph data structures and algorithms, DSA). Даже если вы не знакомы с Sudoku или DSA, полагаю, сможете в целом прочитать код.","type":"unstyled","key":"8h2uj"},{"data":{},"depth":0,"entityRanges":[{"key":4,"length":18,"offset":7}],"inlineStyleRanges":[{"length":26,"offset":0,"style":"ITALIC"}],"text":"Полный исходный код здесь.","type":"unstyled","key":"1jbdb"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Процесс создания игры-головоломки Sudoku можно разбить на пять шагов.","type":"unstyled","key":"cf034"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Создание узлов (nodes) головоломки, представленных плитками (tiles).","type":"unordered-list-item","key":"7da6b"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Создание ребер (edges) головоломки. В данном случае edges — это синоним для взаимосвязей между плитками: строка, столбец и подгруппа.","type":"unordered-list-item","key":"auqsc"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Заполнение (добавление) некоторых значений в структуре, чтобы упростить решение.","type":"unordered-list-item","key":"4dq33"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Решение головоломки.","type":"unordered-list-item","key":"8v1cg"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Раскрытие определенного количества плиток для помощи пользователю.","type":"unordered-list-item","key":"5n03v"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Я использовал нечто похожее на шаблон Builder, чтобы представить эти шаги в функции, которую вызываю для создания головоломки:","type":"unstyled","key":"cg1im"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"internal fun buildNewSudoku(\n boundary: Int,\n difficulty: Difficulty\n): SudokuPuzzle = buildNodes(boundary, difficulty)\n .buildEdges()\n .seedColors()\n .solve()\n .unsolve()","type":"blockquote","key":"dgrna"},{"data":{},"depth":0,"entityRanges":[{"key":5,"length":13,"offset":64}],"inlineStyleRanges":[],"text":"Хотя идея “Nodes” и “Edges” является техническим определением в теории графов, этот код четко отражает пять выбранных шагов.","type":"unstyled","key":"84kmr"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Не рассматривая кодовую базу полностью, хочу отметить, как вспомогательные функции способствуют удобочитаемости вопреки логике:","type":"unstyled","key":"f0r01"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"internal fun SudokuPuzzle.buildEdges(): SudokuPuzzle {\n this.graph.forEach {\n val x = it.value.first.x\n val y = it.value.first.y\n\n it.value.mergeWithoutRepeats(\n getNodesByColumn(this.graph, x)\n )\n\n it.value.mergeWithoutRepeats(\n getNodesByRow(this.graph, y)\n )\n\n it.value.mergeWithoutRepeats(\n getNodesBySubgrid(this.graph, x, y, boundary)\n )\n\n }\n return this\n}\n\ninternal fun LinkedList.mergeWithoutRepeats(new: List) {\n val hashes: MutableList = this.map { it.hashCode() }.toMutableList()\n new.forEach {\n if (!hashes.contains(it.hashCode())) {\n this.add(it)\n hashes.add(it.hashCode())\n }\n }\n}\n\ninternal fun getNodesByColumn(graph: LinkedHashMap>, x: Int): List {\n val edgeList = mutableListOf()\n graph.values.filter {\n it.first.x == x\n }.forEach {\n edgeList.add(it.first)\n }\n return edgeList\n}\n//...","type":"blockquote","key":"92n05"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Подводя итог, можно сказать, что вспомогательные функции дают два преимущества.","type":"unstyled","key":"1e8c3"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Они заменяют фрагмент кода, который что-то делает.","type":"unordered-list-item","key":"1bdr2"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Этому фрагменту кода можно дать описательное имя.","type":"unordered-list-item","key":"a58md"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Решение вопроса о том, следует ли что-то хранить в функции или делегировать во вспомогательную функцию, определяется методом проб и ошибок.","type":"unstyled","key":"9rafa"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[{"length":35,"offset":0,"style":"BOLD"}],"text":"Как использовать комментарии к коду","type":"header-three","key":"fk28r"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"При комментировании кода я предпочитаю два основных подхода. Первый использую для описания сложной функции. Второй (намного более простой) служит для очистки сложных строк и блоков кода.","type":"unstyled","key":"60ug"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[{"length":57,"offset":0,"style":"BOLD"}],"text":"Как использовать комментарии при разработке новых функций","type":"header-three","key":"2ugad"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Сталкиваясь с функциями, которые мне сложно написать, я описываю их функциональность (что они делают) простым языком или псевдокодом.","type":"unstyled","key":"f1pkp"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Особенности описания со временем у меня менялись, поэтому ищите подходящие для вас методы. В предыдущих примерах я пропустил комментарии:","type":"unstyled","key":"b0vnu"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"/**\n * 1. Создание карты, содержащей n*n узлов.\n * 2. для каждого соседнего узла (согласно правилам судоку) добавить Edge в хэш-набор\n * - По столбцу\n * - По ряду\n * - По подгруппе размера n\n *\n * LinkedHashMap: я решил использовать LinkedHashMap, потому что он сохраняет порядок\n * элементов, размещенных на карте, но также позволяет выполнять поиск по хеш-коду, который\n * генерируется значениями x и y.\n *\n * Что касается LinkedList в каждом сегменте (элементе) карты, предположим, что первый элемент\n * — это узел в hashCode(x, y), а последующие — это ребра этого элемента.\n * Помимо упорядочения первого элемента в качестве заголовка LinkedList, остальные\n * не обязательно упорядочивать каким-либо особым образом.\n *\n *\n * */\n\n\ninternal fun buildNodes(n: Int, difficulty: Difficulty): SudokuPuzzle {\n val newMap = LinkedHashMap>()\n\n(1..n).forEach { xIndex ->\n (1..n).forEach { yIndex ->\n val newNode = SudokuNode(\n xIndex,\n yIndex,\n 0\n )\n val newList = LinkedList()\n newList.add(newNode)\n newMap.put(\n newNode.hashCode(),\n newList\n )\n }\n }\n return SudokuPuzzle(n, difficulty, newMap)\n}","type":"blockquote","key":"1u46e"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Детальность комментариев зависит от контекста. Работая в команде, я стараюсь сделать их намного короче, чем представленные выше, оставляя самое необходимое.","type":"unstyled","key":"eg4i6"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Приведенный выше пример был моим учебным проектом, которым я собирался поделиться с другими. Поэтому для представления головоломки Sudoku я даже включил процесс принятия решений по типам.","type":"unstyled","key":"7n6hh"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Поклонники Test Driven Development могут попробовать записать шаги псевдокода алгоритма перед написанием теста:","type":"unstyled","key":"e82i8"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"/**\nВ процессе привязки, вызываемом представлением в onCreate. Проверить текущее состояние пользователя, записать этот результат в\n * vModel, показать график загрузки, выполнить некоторую инициализацию\n *\n * а. Пользователь анонимный\n * б. Пользователь зарегистрирован\n *\n * а:\n * 1. Просмотр загрузки дисплея\n * 2. Проверить наличие вошедшего в систему пользователя из auth: null\n * 3. записать null в пользовательское состояние vModel\n * 4. вызов при запуске процесса\n */\n @Test\n fun `On bind User anonymous`() = runBlocking {\n\n //...\n }","type":"blockquote","key":"ev8ca"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[{"length":31,"offset":60,"style":"BOLD"}],"text":"Это позволит перед реализацией модуля спроектировать его на более высоком уровне абстракции. Потраченное при этом время может быть компенсировано впоследствии.","type":"unstyled","key":"5k9k4"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[{"length":55,"offset":0,"style":"BOLD"}],"text":"Как эффективно использовать построчные комментарии кода","type":"header-three","key":"aqheu"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Комментарии к строкам кода я чаще всего пишу в двух случаях.","type":"unstyled","key":"6ij4h"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Когда чувствую, что впоследствии мне или кому-то другому будет непонятно назначение строки или блока кода.","type":"unordered-list-item","key":"78lo1"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Когда приходится вызывать случайную и неудачно названную библиотечную функцию, которую я не контролирую.","type":"unordered-list-item","key":"cjrgh"},{"data":{},"depth":0,"entityRanges":[{"key":6,"length":16,"offset":62}],"inlineStyleRanges":[],"text":"Безусловно самый сложный алгоритм Sudoku в моей программе — solver algorithm (алгоритм решателя). Он на самом деле очень большой и здесь представлен лишь фрагмент:","type":"unstyled","key":"ct856"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"internal fun SudokuPuzzle.solve()\n : SudokuPuzzle {\n //назначенные узлы (не включая узлы из seedColors()\n val assignments = LinkedList()\n\n ///отслеживать неудачные попытки присваивания для наблюдения за бесконечными циклами\n var assignmentAttempts = 0\n //два этапа возврата, partial — это половина набора данных, full — полный перезапуск. \n var partialBacktrack = false\n\n var fullbacktrackCounter = 0\n\n //от 0 - граница, показывающая насколько \"придирчив\" алгоритм к присвоению новых значений\n var niceValue: Int = (boundary / 2)\n\n //чтобы избежать слишком раннего упрощения\n var niceCounter = 0\n\n //работа с копией\n var newGraph = LinkedHashMap(this.graph)\n //все узлы со значением от of 0 (uncolored)\n val uncoloredNodes = LinkedList()\n newGraph.values.filter { it.first.color == 0 }.forEach { uncoloredNodes.add(it.first) }\n\n while (uncoloredNodes.size > 0) {\n //...\n }\n//...\n}","type":"blockquote","key":"b7n7h"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"При просмотре этого огромного алгоритма уже в середине я мог забывать использованные переменные.","type":"unstyled","key":"ecgit"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Другой случай добавления таких комментариев связан с объяснением или напоминанием о коде, который я не контролирую.","type":"unstyled","key":"2v2sm"},{"data":{},"depth":0,"entityRanges":[{"key":7,"length":4,"offset":29},{"key":8,"length":13,"offset":33}],"inlineStyleRanges":[],"text":"Например, печально известный API Java Calendar использует индексацию месяцев с отсчетом от нуля. Вероятно, это глупо, я не знаю ни одного стандарта, в котором год начинается с нулевого месяца.","type":"unstyled","key":"aem9i"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Не могу поделиться с вами кодом, так как он проприетарный. Но в текущей кодовой базе нашей команды везде есть комментарии для операторов random — 1.","type":"unstyled","key":"752sh"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[{"length":37,"offset":0,"style":"BOLD"}],"text":"Как использовать Enums & Dictionaries","type":"header-three","key":"9h9t0"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Для подобных конструкций кода существуют и другие имена, но я предпочитаю эти. Предположим, у вас есть ограниченный набор значений, используемый для представления определенных объектов.","type":"unstyled","key":"6m1dv"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Например, мне нужен был способ ограничить количество плиток, включенных в новую головоломку Sudoku, учитывая:","type":"unstyled","key":"4s48n"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"размер головоломки (4, 9 и 16 плиток на столбец/строку/подгруппу);","type":"unordered-list-item","key":"ahha"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"сложность головоломки (легкая, средняя, сложная).","type":"unordered-list-item","key":"4080o"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"После обширного тестирования я пришел к следующим значениям модификаторов:","type":"unstyled","key":"86ju"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"enum class Difficulty(val modifier:Double) {\n EASY(0.50),\n MEDIUM(0.44),\n HARD(0.38)\n}\n\ndata class SudokuPuzzle(\n val boundary: Int,\n val difficulty: Difficulty,\n val graph: LinkedHashMap>\n = buildNewSudoku(boundary, difficulty).graph,\n var elapsedTime: Long = 0L\n)//...","type":"blockquote","key":"9cre7"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Эти значения используются в разных местах, где логика должна изменяться в зависимости от сложности.","type":"unstyled","key":"5u9nb"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Иногда вам даже не нужно иметь удобочитаемые имена, связанные со значениями. Я использовал другой enum для представления различных стратегий решения, чтобы гарантировать, что головоломка играбельна относительно выбранной сложности:","type":"unstyled","key":"frjbe"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"enum class SolvingStrategy {\n BASIC,\n ADVANCED,\n UNSOLVABLE\n}\n\ninternal fun determineDifficulty(\n puzzle: SudokuPuzzle\n): SolvingStrategy {\n val basicSolve = isBasic(\n puzzle\n )\n val advancedSolve = isAdvanced(\n puzzle\n )\n //если головоломка становится не разрешима, возвращаем текущую стратегию\n if (basicSolve) return SolvingStrategy.BASIC\n else if (advancedSolve) return SolvingStrategy.ADVANCED\n else {\n puzzle.print()\n return SolvingStrategy.UNSOLVABLE\n }\n}","type":"blockquote","key":"9rsha"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[{"length":64,"offset":58,"style":"BOLD"}],"text":"Общепринятый принцип проектирования любой системы гласит: чем меньше движущихся (меняющихся) частей, тем надежнее система.","type":"unstyled","key":"3scb2"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[{"length":28,"offset":101,"style":"BOLD"}],"text":"Установка ограничений на значения и типы и выбор понятных имен не только облегчает чтение кода, но и может защитить его от ошибок.","type":"unstyled","key":"b31im"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[{"length":54,"offset":0,"style":"BOLD"}],"text":"Как организовать и именовать пакеты, папки и каталоги?","type":"header-three","key":"7sanr"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Любое руководство по удобочитаемому коду будет неполным без обсуждения пакетов. Если предпочитаемые вами платформа и язык не используют этот термин, тогда предположим, что я имею в виду папку или каталог.","type":"unstyled","key":"7u7kh"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"По этому поводу я несколько раз менял свое мнение, что отражено в моих старых проектах.","type":"unstyled","key":"11spa"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Два основных подхода к организации пакетов:","type":"unstyled","key":"34h8u"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"пакет как архитектурный слой;","type":"unordered-list-item","key":"d5757"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"пакет как функция.","type":"unordered-list-item","key":"6bagd"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[{"length":14,"offset":0,"style":"BOLD"}],"text":"Пакет как слой","type":"header-three","key":"d92pc"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Пакет как слой — первая и наименее удачная система из использованных мной. Идея обычно основана на следовании некоторым архитектурным паттернам, таким как MVC, MVP, MVVM и т.д.","type":"unstyled","key":"1k8uv"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Если взять MVC в качестве примера, структура пакета верхнего уровня будет выглядеть следующим образом:","type":"unstyled","key":"eat74"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"модель;","type":"unordered-list-item","key":"ctlva"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"вид;","type":"unordered-list-item","key":"89hed"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"контроллер.","type":"unordered-list-item","key":"1d5i6"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Первая проблема такого подхода заключается в том, что каждый класс и функция удобно помещаются в одном из этих слоев. На практике так бывает редко.","type":"unstyled","key":"fspda"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Я также считаю этот подход менее удобочитаемым, поскольку верхний уровень дает только самые общие сведения о том, чего ожидать внутри каждого пакета.","type":"unstyled","key":"euha8"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Этот подход обычно можно улучшить, добавив “слоев” для специфики:","type":"unstyled","key":"2dvv4"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"UI;","type":"unordered-list-item","key":"4jp87"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"модель;","type":"unordered-list-item","key":"bd6a9"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"API;","type":"unordered-list-item","key":"8ukk2"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"хранилище;","type":"unordered-list-item","key":"30v8c"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"домен;","type":"unordered-list-item","key":"f3ds2"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"общий.","type":"unordered-list-item","key":"15fm3"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Такой подход будет достаточно хорошо работать в небольших кодовых базах, где все разработчики знакомы с общими используемыми паттернами и стилями.","type":"unstyled","key":"fmnho"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[{"length":17,"offset":0,"style":"BOLD"}],"text":"Пакет как функция","type":"header-three","key":"62epr"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Пакет как функция имеет свои недостатки, но его, как правило, проще просматривать и читать. Это опять же при условии, что вы даете пакетам хорошие имена.","type":"unstyled","key":"3300n"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[{"length":31,"offset":124,"style":"BOLD"}],"text":"Термин «функция» сложно описать, но я обычно определяю его как экран/страницу или набор экранов/страниц, которые определяют основную часть функциональности для пользователей или клиентов.","type":"unstyled","key":"5enre"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Для приложения-соцсети структура может быть такой:","type":"unstyled","key":"7me4s"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"таймлайн;","type":"unordered-list-item","key":"c9m6d"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"друзья;","type":"unordered-list-item","key":"3dsia"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"профиль пользователя;","type":"unordered-list-item","key":"8l5v7"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"сообщения;","type":"unordered-list-item","key":"5afqf"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"детали сообщения.","type":"unordered-list-item","key":"6u9bh"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Основная проблема у пакета как функции противоположна пакету как слою: почти всегда будут объекты, которые используются в нескольких функциях.","type":"unstyled","key":"6i7ne"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[{"length":31,"offset":62,"style":"BOLD"}],"text":"У этой проблемы есть два решения. Первое предполагает наличие дубликата кода в каждой функции.","type":"unstyled","key":"6saka"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[{"length":1,"offset":26,"style":"BOLD"},{"length":1,"offset":29,"style":"BOLD"},{"length":63,"offset":53,"style":"BOLD"}],"text":"Хотите верьте, хотите нет, но дублирующие объекты ПО могут оказаться невероятно полезными в корпоративных настройках в определенных ситуациях.","type":"unstyled","key":"2kgeg"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Однако обычно я рекомендуемое второе решение.","type":"unstyled","key":"7iuke"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[{"length":37,"offset":0,"style":"BOLD"}],"text":"Реализуем структуру гибридного пакета","type":"header-three","key":"b3rgf"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Обычно рекомендуемое разработчикам решение я называю гибридным подходом. Он очень простой и гибкий, должен удовлетворять большинство ваших требований:","type":"unstyled","key":"bp86s"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"таймлайн;","type":"unordered-list-item","key":"lcp6"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"друзья;","type":"unordered-list-item","key":"f19rk"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"сообщения;\n — все сообщения;\n — разговор;\n — детали сообщения.","type":"unordered-list-item","key":"9hooa"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"API;\n — график;\n — пользователь;\n — сообщение.","type":"unordered-list-item","key":"7it88"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"компоненты пользовательского интерфейса.","type":"unordered-list-item","key":"ag2vo"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Не стоит воспринимать этот пример как единственно верное решение. Я пытался передать общую идею: в этот пакет входит все, что относится к функциям. Все, что передается между функциями, попадает в отдельный пакет, вложенный на том же или на более высоком уровне.","type":"unstyled","key":"auf56"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[{"length":85,"offset":128,"style":"BOLD"}],"text":"Кроме того, определение слоя здесь является расплывчатым понятием, поэтому слепо придерживаться этой концепции тоже не следует. Критически осмыслите изложенный материал, особенно те, кто не знаком с этим проектом.","type":"unstyled","key":"40pea"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[{"length":10,"offset":0,"style":"BOLD"}],"text":"Заключение","type":"header-three","key":"b599o"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Большая часть моих предпочтений в отношении удобочитаемости и стиля кода получены после множества проб различных подходов. Иногда это были подсмотренные у других разработчиков подходы, а некоторые появились сами собой.","type":"unstyled","key":"e33s6"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Если сможете поставить себя в положение разработчика, незнакомого с вашим кодом или программой, тогда вам будет легче писать чистый код, доступный для чтения как книга.","type":"unstyled","key":"bb4e5"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"Читайте также:","type":"unstyled","key":"k6vs"},{"data":{},"depth":0,"entityRanges":[{"key":9,"length":52,"offset":0}],"inlineStyleRanges":[],"text":"Чистота и порядок: 3 правила для идеальной базы кода","type":"unordered-list-item","key":"34rjj"},{"data":{},"depth":0,"entityRanges":[{"key":10,"length":54,"offset":0}],"inlineStyleRanges":[],"text":"Двоичные деревья: управляемый подход к поиску значений","type":"unordered-list-item","key":"9uslp"},{"data":{},"depth":0,"entityRanges":[{"key":11,"length":36,"offset":0}],"inlineStyleRanges":[],"text":"Как ваша программа использует память","type":"unordered-list-item","key":"7832b"},{"data":{},"depth":0,"entityRanges":[{"key":12,"length":8,"offset":14},{"key":13,"length":2,"offset":24}],"inlineStyleRanges":[],"text":"Читайте нас в Telegram, VK","type":"unstyled","key":"fktn4"},{"data":{},"depth":0,"entityRanges":[{"key":14,"length":16,"offset":15},{"key":15,"length":50,"offset":33}],"inlineStyleRanges":[{"length":14,"offset":0,"style":"ITALIC"}],"text":"Перевод статьи Ryan Michael Kay: Clear Code: How To Write Code That Is Easy To Read","type":"unstyled","key":"ef8f4"},{"data":{},"depth":0,"entityRanges":[],"inlineStyleRanges":[],"text":"","type":"marker","key":"E8DVAh9Ry1Q8nXYsAUzF"}],"entityMap":{"11":{"data":{"href":"https://nuancesprog.ru/p/2627/","url":"https://nuancesprog.ru/p/2627/"},"mutability":"MUTABLE","type":"LINK"},"12":{"data":{"href":"https://t.me/nuancesprog","url":"https://t.me/nuancesprog"},"mutability":"MUTABLE","type":"LINK"},"13":{"data":{"href":"https://vk.com/nuancesprog","url":"https://vk.com/nuancesprog"},"mutability":"MUTABLE","type":"LINK"},"14":{"data":{"href":"https://medium.com/@rkay301","url":"https://medium.com/@rkay301"},"mutability":"MUTABLE","type":"LINK"},"15":{"data":{"href":"https://medium.com/didact-publication/clear-code-how-to-write-code-that-is-easy-to-read-fc8f12820592","url":"https://medium.com/didact-publication/clear-code-how-to-write-code-that-is-easy-to-read-fc8f12820592"},"mutability":"MUTABLE","type":"LINK"},"0":{"data":{"url":"https://nuancesprog.ru/p/17302/"},"mutability":"MUTABLE","type":"LINK"},"1":{"data":{"url":"https://aflink.ru/g/os57fawizi1470bcbdb40da0172cefd8d80a1f4f/?erid=LatgBV3Ep"},"mutability":"MUTABLE","type":"LINK"},"2":{"data":{"href":"https://en.wikipedia.org/wiki/Cohesion_%28computer_science%29","url":"https://en.wikipedia.org/wiki/Cohesion_%28computer_science%29"},"mutability":"MUTABLE","type":"LINK"},"3":{"data":{"href":"https://en.wikipedia.org/wiki/Sudoku","url":"https://en.wikipedia.org/wiki/Sudoku"},"mutability":"MUTABLE","type":"LINK"},"4":{"data":{"href":"https://github.com/BracketCove/GraphSudokuOpen/tree/master/app/src/main/java/com/bracketcove/graphsudoku/computationlogic","url":"https://github.com/BracketCove/GraphSudokuOpen/tree/master/app/src/main/java/com/bracketcove/graphsudoku/computationlogic"},"mutability":"MUTABLE","type":"LINK"},"5":{"data":{"href":"https://en.wikipedia.org/wiki/Graph_theory","url":"https://en.wikipedia.org/wiki/Graph_theory"},"mutability":"MUTABLE","type":"LINK"},"6":{"data":{"href":"https://github.com/BracketCove/GraphSudokuOpen/blob/master/app/src/main/java/com/bracketcove/graphsudoku/computationlogic/SolveSudoku.kt","url":"https://github.com/BracketCove/GraphSudokuOpen/blob/master/app/src/main/java/com/bracketcove/graphsudoku/computationlogic/SolveSudoku.kt"},"mutability":"MUTABLE","type":"LINK"},"7":{"data":{"href":"https://docs.oracle.com/javase/7/docs/api/java/util/Calendar.html#MONTH","url":"https://docs.oracle.com/javase/7/docs/api/java/util/Calendar.html#MONTH"},"mutability":"MUTABLE","type":"LINK"},"8":{"data":{"href":"https://docs.oracle.com/javase/7/docs/api/java/util/Calendar.html#MONTH","url":"https://docs.oracle.com/javase/7/docs/api/java/util/Calendar.html#MONTH"},"mutability":"MUTABLE","type":"LINK"},"9":{"data":{"href":"https://nuancesprog.ru/p/17264/","url":"https://nuancesprog.ru/p/17264/"},"mutability":"MUTABLE","type":"LINK"},"10":{"data":{"href":"https://nuancesprog.ru/p/880/","url":"https://nuancesprog.ru/p/880/"},"mutability":"MUTABLE","type":"LINK"}}},"mentions":[]}