Я не буду давать советы о том, что следует грамотно продумывать архитектуру системы, применять шаблоны, использовать библиотеки и тому подобные вещи.
Всё это сложно, неочевидно и чревато долгими спорами.
Я дам несколько простых советов, следовать которым так же просто, как мыть руки перед едой.
Используйте силу папок. Самых обычных папок. В которых лежат файлы. Мощнейщее средство для организации файлов вашего проекта. Если количество файлов в папке перевалило за десяток – пришла пора создавать вложенные папки. Впрочем, десяток – это уже много, достаточно пяти. Не важно, как группировать. Важно одно – в папке на должно быть больше пяти файлов.
Группируйте функции внутри файла. Большинство современных языков имеют средства для этого (pragma mark, region и т.п.). В вашем языке нет таких средств? Используйте комментарии. Неважно, по каким критериям группировать. Важно одно – функции должны быть сгруппированы, и каждой группе должно быть назначено имя.
Если внутри функции содержится больше пятидесяти строк, смело вытаскивайте куски кода в отдельные функции. Неважно, какими принципами вы будете руководствоваться для вычленения кода. Важно одно – функция не должна содержать больше пятидесяти строк.
Если в файле больше пятисот строк, он превратился в кашу. Делайте новый файл, и вытаскивайте туда группы функций. Неважно, согласно каким принципам вы будете вытаскивать функции. Важно одно – файл не должен содержать больше пятисот строк, включая пустые.
Между функциями должно быть расстояние в пять строк. Если меньше – ваш файл представляет собой нечитаемое месиво из слов и символов. Мозг не должен тратить энергию и время на визуальное выделение функций в мешанине кода.
Не нужно ставить перед функциями девятиэтажные комментарии – пять пустых строк справятся гораздо лучше.
Ваш код не должен требовать словесного описания того, что он делает и как он это делает. Назначение кода и принцип его работы должен быть понятен из самого кода. Современные языки программирования достаточно близки к естественному языку и к математическим нотациям. Если вы не можете ясно выразить алгоритм средствами языка программирования, то и в комментариях вы не напишете ничего внятного.
Настройте ваш редактор так, чтобы комментарии сильно выделялись в тексте – оранжевым на черном или красным на белом.
Используйте символ подчеркивания для разделения слов в названиях переменных и функций. В нормальном письме слова разделяются пробелами и знаками препинания. В языках программирования эти символы нельзя использовать в именах. Из всех форм записи многословных идентификаторов, наиболее близкий к естественному – использование подчеркивания вместо пробела.
Это простые и однозначные правила. Не нужно сильно чесать репу, чтобы им следовать. Просто попробуйте. И через некоторое время вы заметите, что эти несложные правила выстраивают ваш код в красивые и ясные архитектурные решения. Работать с написанным кодом становится легко и приятно.
P.S. Используйте темные темы редактора кода. Это стильно, красиво и приятно для глаз. Цвет фона должен быть не черным, а темно-темно-серым, дабы не было сильного контраста с текстом.
P.P.S. Настройте расцветку кода так, чтобы ключевые слова были серых тонов и не притягивали к себе внимания. Цветовой акцент должен быть на названиях переменных, функций и прочих предметных словах.
Всё это сложно, неочевидно и чревато долгими спорами.
Я дам несколько простых советов, следовать которым так же просто, как мыть руки перед едой.
Группируйте файлы
Используйте силу папок. Самых обычных папок. В которых лежат файлы. Мощнейщее средство для организации файлов вашего проекта. Если количество файлов в папке перевалило за десяток – пришла пора создавать вложенные папки. Впрочем, десяток – это уже много, достаточно пяти. Не важно, как группировать. Важно одно – в папке на должно быть больше пяти файлов.
Группируйте функции
Группируйте функции внутри файла. Большинство современных языков имеют средства для этого (pragma mark, region и т.п.). В вашем языке нет таких средств? Используйте комментарии. Неважно, по каким критериям группировать. Важно одно – функции должны быть сгруппированы, и каждой группе должно быть назначено имя.
Ограничьте размер функции
Если внутри функции содержится больше пятидесяти строк, смело вытаскивайте куски кода в отдельные функции. Неважно, какими принципами вы будете руководствоваться для вычленения кода. Важно одно – функция не должна содержать больше пятидесяти строк.
Ограничьте размер файла
Если в файле больше пятисот строк, он превратился в кашу. Делайте новый файл, и вытаскивайте туда группы функций. Неважно, согласно каким принципам вы будете вытаскивать функции. Важно одно – файл не должен содержать больше пятисот строк, включая пустые.
Отделяйте функции друг от друга
Между функциями должно быть расстояние в пять строк. Если меньше – ваш файл представляет собой нечитаемое месиво из слов и символов. Мозг не должен тратить энергию и время на визуальное выделение функций в мешанине кода.
Не нужно ставить перед функциями девятиэтажные комментарии – пять пустых строк справятся гораздо лучше.
Избавляйтесь от комментариев
Ваш код не должен требовать словесного описания того, что он делает и как он это делает. Назначение кода и принцип его работы должен быть понятен из самого кода. Современные языки программирования достаточно близки к естественному языку и к математическим нотациям. Если вы не можете ясно выразить алгоритм средствами языка программирования, то и в комментариях вы не напишете ничего внятного.
Настройте ваш редактор так, чтобы комментарии сильно выделялись в тексте – оранжевым на черном или красным на белом.
Кэмел-стайл и Паскаль-стайл – зло
Используйте символ подчеркивания для разделения слов в названиях переменных и функций. В нормальном письме слова разделяются пробелами и знаками препинания. В языках программирования эти символы нельзя использовать в именах. Из всех форм записи многословных идентификаторов, наиболее близкий к естественному – использование подчеркивания вместо пробела.
Всё
Это простые и однозначные правила. Не нужно сильно чесать репу, чтобы им следовать. Просто попробуйте. И через некоторое время вы заметите, что эти несложные правила выстраивают ваш код в красивые и ясные архитектурные решения. Работать с написанным кодом становится легко и приятно.
P.S. Используйте темные темы редактора кода. Это стильно, красиво и приятно для глаз. Цвет фона должен быть не черным, а темно-темно-серым, дабы не было сильного контраста с текстом.
P.P.S. Настройте расцветку кода так, чтобы ключевые слова были серых тонов и не притягивали к себе внимания. Цветовой акцент должен быть на названиях переменных, функций и прочих предметных словах.