Користувальницькі налаштування

Налаштування сайту


codingguidelines

Розбіжності

Тут показані розбіжності між вибраною ревізією та поточною версією сторінки.

Посилання на цей список змін

Порівняння попередніх версійПопередня ревізія
Наступна ревізія
Попередня ревізія
codingguidelines [2023/12/12 13:58] – nightflycodingguidelines [2026/10/22 18:45] (поточний) – [Збереження Legacy] nightfly
Рядок 61: Рядок 61:
 ==== PHP-теги ==== ==== PHP-теги ====
  
-PHP-код обов'язково слід розміщувати в повній версії (<?php ?>) тегів або в скороченій (скорочений запис echo) версію (<?= ?>) тегів і неприпустимо поміщати в жодні інші різновиди тегів типу (типу <%).+PHP-код обов'язково слід розміщувати в повній версії (<?php ?>) тегів або в скороченій (скорочений запис echo) версію (<?= ?>) тегів і неприпустимо поміщати в жодні інші різновиди тегів типу (типу <%). Закриваючий тег (?>) можна пропускати.
  
  
Рядок 83: Рядок 83:
  
 <code php> <code php>
-$enableFlag = (wf_CheckGet(array('enablesomething'))) ? true : false;+$enableFlag = (ubRouting::checkGet('enablesomething')) ? true : false;
 </code> </code>
  
 Щодо скорочених AND (&&) OR (||) все залишається на вашій совісті, але загалом економія одного байта у випадку AND та економія нуля байт у випадку OR може не коштувати погіршення читабельності та самоочевидності вашого коду.  Щодо скорочених AND (&&) OR (||) все залишається на вашій совісті, але загалом економія одного байта у випадку AND та економія нуля байт у випадку OR може не коштувати погіршення читабельності та самоочевидності вашого коду. 
  
-На тему табів, відступів та іншого - більшість розробників використовує IDE NetBeans і рефлекторно натискає **Alt+Shift+F** для автоматичного форматування коду.+На тему табів, відступів та іншого - більшість розробників використовує IDE NetBeans та Visual Studio Code і рефлекторно натискає **Alt+Shift+F** для автоматичного форматування коду.
  
 ==== Іменування змінних та констант ==== ==== Іменування змінних та констант ====
Рядок 124: Рядок 124:
 </code> </code>
  
-Винятком для односкладового і простого іменування змінних є загальноприйняті і містечково прийняті імена змінних для типових операцій, які використовуються у нас здебільшого під час перебору масивів. Прикладами таких допустимих змінних можуть бути:+Винятком для однобуквового і простого іменування змінних є загальноприйняті та місцево прийняті імена змінних для типових операцій, які використовуються у нас здебільшого під час перебору масивів. Прикладами таких допустимих змінних можуть бути:
  
 <code php> <code php>
Рядок 145: Рядок 145:
 } }
 </code> </code>
 +
 +А ось взагалі дуже [[https://www.youtube.com/watch?v=-J3wNP6u5YU|чудове та пізнавальне відео]] про те як іменувати штуки в коді.
  
 ==== Іменування класів та об'єктів ==== ==== Іменування класів та об'єктів ====
Рядок 258: Рядок 260:
 **Щодо збереження легасі на рівні передбачуваності поведінки системи**: якщо ви робите функціонал, який змінює поведінку системи за замовчуванням, пам'ятайте, що робите ви його передусім не для себе, а для купи мереж, які сподіваються, що після оновлення поведінка їхньої системи буде передбачуваною та звичною, а дівчатка-касирки не почнуть писати заяви про звільнення паралельно з системними адміністраторами, які викидаються з вікон. Якщо для реалізації запланованого вами функціоналу потрібно змінити поведінку системи, цей функціонал потрібно вимкнути за допомогою файлів конфігурації та відключити за замовчуванням. Погодьтеся, ви не будете радіти тому, що після оновлення під час спроби потрапити до профілю користувача, ви замість нього побачите фотку цицьок, нехай навіть дуже гарних. Кожного разу, коли вам хочеться зробити "для всіх" щось, що здається вам дуже крутим, подивіться для [[http://stats.ubilling.net.ua/graph/|скількох]] мереж ви хочете зробити життя "веселішим" і адекватно оцініть шанси на потрапляння цього в мейнстрім. **Щодо збереження легасі на рівні передбачуваності поведінки системи**: якщо ви робите функціонал, який змінює поведінку системи за замовчуванням, пам'ятайте, що робите ви його передусім не для себе, а для купи мереж, які сподіваються, що після оновлення поведінка їхньої системи буде передбачуваною та звичною, а дівчатка-касирки не почнуть писати заяви про звільнення паралельно з системними адміністраторами, які викидаються з вікон. Якщо для реалізації запланованого вами функціоналу потрібно змінити поведінку системи, цей функціонал потрібно вимкнути за допомогою файлів конфігурації та відключити за замовчуванням. Погодьтеся, ви не будете радіти тому, що після оновлення під час спроби потрапити до профілю користувача, ви замість нього побачите фотку цицьок, нехай навіть дуже гарних. Кожного разу, коли вам хочеться зробити "для всіх" щось, що здається вам дуже крутим, подивіться для [[http://stats.ubilling.net.ua/graph/|скількох]] мереж ви хочете зробити життя "веселішим" і адекватно оцініть шанси на потрапляння цього в мейнстрім.
  
-**З приводу збереження легасі на рівні коду**: на даний момент, ми змушені підтримувати працездатність Ubilling від PHP 5.3 до PHP 7.4 та PHP 8.2 з PHP 8.3 (так, це можливо і зовсім не складно), через велику кількість старих установок, які міняти та перевстановлювати на проді, ніхто не буде, так як вони успішно працюють роками. Тому утримайтеся як від використання нового синтаксису масивів із квадратними брекетами у вигляді +**З приводу збереження легасі на рівні коду**: на даний момент, ми змушені підтримувати працездатність Ubilling від PHP 5.3 до PHP 7.4, PHP 8.2 та 8.5 (так, це можливо і зовсім не складно), через велику кількість старих установок, які міняти та перевстановлювати на проді, ніхто не буде, так як вони успішно працюють роками. Тому утримайтеся як від використання нового синтаксису масивів із квадратними брекетами у вигляді 
  
 <code php> <code php>
Рядок 284: Рядок 286:
 </code> </code>
  
-Також не використовуйте функціонал, який давно deprecated і помре з дня на день, такого плану, як скажімо ereg_replace. +Також не використовуйте функціонал, який давно deprecated і помре з дня на день, такого плану, як скажімо ereg_replace, each тощо. Ось також ще список операторів, які наглухо ламають сумісність коду в діапазоні 5.3-8.5:  
 +<code> 
 +**, **=, ..., ??, <=>, ??=, ?->, |> 
 +</code>  
 + 
 +Користуйтесь трішки головою.
  
 У разі, якщо вам потрібно змінити наявний код, що вже працює, переконайтесь, що його поведінка радикально не зміниться. Якщо вам потрібно додати якісь параметри до функції або методу - додавайте їх наприкінці оголошення функції, за можливістю вказуйте дефолтні значення, і переконайтеся, що з ними чи без них, функція залишиться працездатною і збереже свою попередню поведінку. Якщо з якихось причин це неможливо, ви **зобов'язані переглянути всі** місця, де використовується ця функція або метод, доповнити їх передачею правильних параметрів, і переконатися в адекватному функціонуванні всіх цих місць.  У разі, якщо вам потрібно змінити наявний код, що вже працює, переконайтесь, що його поведінка радикально не зміниться. Якщо вам потрібно додати якісь параметри до функції або методу - додавайте їх наприкінці оголошення функції, за можливістю вказуйте дефолтні значення, і переконайтеся, що з ними чи без них, функція залишиться працездатною і збереже свою попередню поведінку. Якщо з якихось причин це неможливо, ви **зобов'язані переглянути всі** місця, де використовується ця функція або метод, доповнити їх передачею правильних параметрів, і переконатися в адекватному функціонуванні всіх цих місць. 
  
-Якщо ви пишете щось поруч з існуючим кодом, що в основному повторює його функціональність, але несе підтримку іншого функціоналу, постарайтеся слідувати ідеології та стилю оригіналу. Цілком можливо, що хтось за вами буде це лагодити і допилювати. Не потрібно викликати в нього когнітивний дисонанс.+Якщо ви пишете щось поруч з існуючим кодом, що в основному повторює його функціональність, але несе підтримку іншого функціоналу, постарайтеся слідувати ідеології та стилю оригіналу. Цілком можливо, що хтось за вами буде це лагодити і допилювати. Не потрібно викликати в нього когнітивний дисонанс. 
  
 ==== Коментування коду ==== ==== Коментування коду ====
Рядок 505: Рядок 512:
 git add CONTRIBUTING.md git add CONTRIBUTING.md
 git commit -m "I add some line to CONTRIBUTING" git commit -m "I add some line to CONTRIBUTING"
-git push —set-upstream my-fork master-some-fix+git push -u my-fork master-some-fix
 </code> </code>
  
codingguidelines.1702382311.txt.gz · Востаннє змінено: повз nightfly

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki