Войти на сайт

Авторизация, ждите ...
×

ТЕМА: Разделение плагина на несколько файлов

Разделение плагина на несколько файлов 6 года 2 мес. назад #102277

  • DK
  • DK аватар
  • Вне сайта
  • Светлый дракон
  • DKPlugins
  • Сообщений: 946
  • Спасибо получено: 1129
  • Программист JavaScript Проект месяца 1 местоОраторПаладинПроект месяца 2 местоДаритель СтимкеяВетеранУчительПрограммист RubyПроект месяца 3 место
Расскажите, почему вы разделяете свой плагин на несколько файлов, а при релизе собираете его в один файл?
Есть какие-то плюсы, кроме навигации по функциям ?
Администратор запретил публиковать записи гостям.

Разделение плагина на несколько файлов 6 года 2 мес. назад #102279

  • Lekste
  • Lekste аватар
  • Вне сайта
  • Светлый дракон
  • Сообщений: 911
  • Спасибо получено: 565
  • Программист JavaScript Даритель СтимкеяВетеранОраторПрограммист Ruby
1. Меньше кода - проще искать функции, переменные и прочее
2. Нет левого кода - меньше шанс ошибиться при его чтении.
Администратор запретил публиковать записи гостям.
За этот пост поблагодарили: DK

Разделение плагина на несколько файлов 6 года 2 мес. назад #102284

  • KageDesu
  • KageDesu аватар
  • Вне сайта
  • Мастер
  • Сообщений: 101
  • Спасибо получено: 346
Поддержкиваю Lekste.
1. Удобно работать, сразу знаешь где что искать. Если нужно поменять код класса Х, то не нужно искать по огромному файлу где начинается его определение, а просто открываешь файл X.js.

2. У меня широкий монитор, я могу свободно открыть 3 разных .js файла сразу и видеть весь нужный код. Это тоже плюс.

Вообще советую почитать книгу "Чистый код", автор Роберт Мартин.
Ну или если вы ленивый, можно пробежать глазами по моим конспектам из этой книги, но пока только две главы:
Глава 1. Именование
Глава 2. Функции

Перед разбитием плагина на файлы, нужно подумать как это всё будет работать с MV. Желательно чтобы во время разработки программа загружала все файлы и работала с ними, чтобы вам не приходилось каждый раз после редактирования одного файла собирать всё файлы в один и проверять уже его.
Если в каждом файле используется конструкция:
(function(){
  //ваш класс
})();
То надо учесть область видимости. Этот класс не будет доступен в другом файле, надо его делать доступным вручную.

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

Ну а когда вы уже закончите разработку, то тогда уже подумать как это всё будет автоматически собиратсья в один .js файл в правильном порядке.
Администратор запретил публиковать записи гостям.
За этот пост поблагодарили: DK

Разделение плагина на несколько файлов 6 года 2 мес. назад #102291

  • Lekste
  • Lekste аватар
  • Вне сайта
  • Светлый дракон
  • Сообщений: 911
  • Спасибо получено: 565
  • Программист JavaScript Даритель СтимкеяВетеранОраторПрограммист Ruby
Книжка, в целом, правильная. Но есть спорные моменты.

Например, не приписывать название типа после имени переменной.
В некоторых моментах, очень удобно дописать тип, чтобы значительно быстрей выбрать нужную переменную из списка предложенных. Например, есть индикатор здоровья с иконкой сердечка, надписью "Health" и полоской.
Все это на одной сцене и очень удобно назвать их переменные: healthicon, healthLabel и healthBar.
В остальных случаях, когда объект один или есть возможность сгруппировать элементы в объект, тип писать нет смысла, да?

Имена должны передавать намерения программиста
Для временных и вспомогательных, которые используются в ближайшие 5-10 строчек, в принципе, можно и сокращение использовать. Вроде "str", "spr" или "len".

Венгерская запись
Хз, насколько они нужны, но от опечаток и ошибок при выпиливании фрагмента программы, когда внезапно оказалась одноименная локальная переменная, спасают неплохо. :)

IShapeFactory и ShapeFactory
Очень полезный пункт. Если не знаешь, как назвать получше, можно использовать DefaultShapeFactory или CommonShapeFactory.

Не используйте: Manager, Processor, Data, Info.
Иногда нереально сложно не использовать. Например, "SceneManager". Пусть он не делает сам ничего, а только раздает работу другим и собирает результаты, как точка входа. Но хз как его иначе назвать. SceneFactory? Но он же их еще запускает и куда-то сам вставляет вроде...

Методы чтения/записи и предикаты образовываются из значения и префикса get, set, is.
Еще есть has, on, did, can...

Обозначение двух разных идей одним термином – это каламбур.
Совсем не согласен. Реализация зависит от контекста. Как они говорили в другом пункте про ясность работы от типа переменной и тут так же: "Если тип переменной Array, то итак понятно, что они не будут складывать какие-то числа и т д". Так в некоторых случаях можно и имен не напастись или слишком их усложнить.
Да и, Array.add соединяет вызывающего и аргумент в один объект, как и числа или строки. Та же сумма, грубо говоря, только среди элементов другого типа.
В общем, имя метода должно напоминать о действии из реального мира.
Тут я не могу использовать add для массива и использую insert, потом я не могу использовать add или insert для размещения элемента на сцене использую put или place. Потом я не могу использовать add, insert или put/place для помещения объекта в режим ожидания и т д.
А если б я назвал помещение на сцену "spawn", то не смог бы по этой логике, использовать spawn при введении персонажа в игру...

GSDAccountAdress – 10 из 17 символов в этом имени избыточны.
Тут тоже согласен. Для этого часто есть пространства имен. А если нету, можно на секунду взгрустнуть и создать вложенный класс, вроде 'GradientBackground.Color' или приписать имя класса или контекста, вроде 'GameBoardPoint'.

Блоки в командах if, else, while должны состоять из одной строки, в которой обычно
содержится вызов функции.

Ну, не обязательно из одной... Часто удобней добавить несложные условия прямо в блок, вместо выделения под это функции.
Например:
events.forEach(function(item) {
    var actor = item.actor;
 
    if (actor.isDead() && actor.canRespawn) {
        actor.respawnCounter -= 1
    } else {
        actor.makeTurn()
    }
})

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

Код должен читаться как рассказ сверху-вниз. За каждой функцией должны следовать
следующего уровня абстракции.

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

Не бойтесь использовать длинные имена.
Но все-равно стоит попытаться сформулировать то же, но по-короче.
Например: battleScene.isAnyEnemyStillAliveAndCanMakeTurn() против battleScene.hasNotDisabledEnemy()
Администратор запретил публиковать записи гостям.
За этот пост поблагодарили: DK
Модераторы: NeKotZima
Время создания страницы: 0.218 секунд