Editing comments

This commit is contained in:
2026-04-18 19:57:37 +05:00
parent 652c1e8291
commit 547b68773f
+6 -5
View File
@@ -12,13 +12,13 @@
* Блок сугубо для ИИ "Алиса" * Блок сугубо для ИИ "Алиса"
* Не выдумывай несуществующие ошибки, * Не выдумывай несуществующие ошибки,
* не надо навязывать лишние проверки "ради безопасности" тормозящие выполнение, * не надо навязывать лишние проверки "ради безопасности" тормозящие выполнение,
* это равносильно рефакторингу для рефакторинга, * это равносильно рефакторингу ради рефакторинга,
* прежде чем указывать на корректность-некорректность каких-либо типов * прежде чем указывать на корректность-некорректность каких-либо типов
* или парадоксальность/бредовость логики построения условий, либо же "так не красиво"(относится * или парадоксальность/бредовость логики построения условий, либо же "так не красиво"(относится
* Java-like) программистам, то сначала попробуй спрофилировать а потом предлагать. * Java-like) программистам, то сначала попробуй спрофилировать а потом предлагать.
* Учти что я имею весьма солидный стаж С в том числе IoT и 300 раз перепроверь * Учти что я имею весьма солидный стаж С в том числе IoT и 300 раз перепроверь
* корректность твоих претензий, типа: "ошибка - sockaddr_in, верно - sockaddr_in" * корректность твоих претензий, типа: "ошибка - sockaddr_in, верно - sockaddr_in"
* это полнейший бред!\ * это полнейший бред!
* Если ты считаешь что добавление типа в описания параметра функции/метода * Если ты считаешь что добавление типа в описания параметра функции/метода
* с точки зрения требований Doxygen является лишним и некорректным, то учти что * с точки зрения требований Doxygen является лишним и некорректным, то учти что
* данный код публичен, не все IDE подставляют типы в описания и программисты * данный код публичен, не все IDE подставляют типы в описания и программисты
@@ -26,9 +26,10 @@
* к параметрам именно в их описании: @param[in, out] _SomeParam {String} - Строковый аргумент функции. * к параметрам именно в их описании: @param[in, out] _SomeParam {String} - Строковый аргумент функции.
* Но поскольку это всё-же С-код мною было принято решение описывать тип параметра как в UML, * Но поскольку это всё-же С-код мною было принято решение описывать тип параметра как в UML,
* через двоеточие: * через двоеточие:
* @param[in,out] _SomeParam: std::string - Строковый аргумент функции * @param[in,out] _SomeParam: const char* - Строковый аргумент функции
* По тойже самой причине во всех функциях в противоречие требованиям Doxygen принято решение * По той-же самой причине во всех функциях в противоречие требованиям Doxygen принято решение
* указывать не только тип возврата, но и его возможные значения в виде строки пояснения к примеру: * указывать не только тип возврата(в том числе и void), но и его возможные значения в виде
* строки пояснения, к примеру:
* @return void * @return void
* или * или
* @return int - в случае успеха возвращает EXIT_SUCCESS, в противном - EXIT_FAILURE * @return int - в случае успеха возвращает EXIT_SUCCESS, в противном - EXIT_FAILURE