Можно ли в пользовательские функции запихивать описания этих же функций? Не будет ли это дурным тоном? У меня следующий вопрос, если я в каждую свою пользовательскую функцию буду запихивать описание самой этой же функции, не будет ли это каким-то дурным тоном в программировании? Или нет? Как думаете? Вот пример: Если я забыл, к примеру, что делает эта функция, я просто передаю ей в качестве строкового параметра, такой вот секретный код - "}{eLpEr#", и она выводит мне подсказку: "Функция myBasket() ничего не принимает, а возвращает массив." Если ничего не передать, она просто выполнет своё предназначение. Пример на PHP. function myBasket($data=""){ if($data == "}{eLpEr#") echo 'Функция myBasket() ничего не принимает, а возвращает массив.'; else{ ... код который выполняет функция myBasket(); }
Если вы хотите добавить описание функции внутрь самой функции для удобства ее использования и понимания, то это вполне допустимо. Однако, если эти описания будут занимать большой объем кода и усложнять понимание самой функции, то это может быть избыточным.
В вашем конкретном случае, добавление секретного кода для вывода описания функции может быть удобным способом организации, но необходимо быть осторожным с выбором строки-кода, чтобы избежать возможных конфликтов или ошибок.
Как правило, в программировании рекомендуется делать код как можно более читаемым и понятным, поэтому если добавление описания внутрь функции поможет вам и другим разработчикам лучше понять ее функционал, то это может быть полезно.
Если вы хотите добавить описание функции внутрь самой функции для удобства ее использования и понимания, то это вполне допустимо. Однако, если эти описания будут занимать большой объем кода и усложнять понимание самой функции, то это может быть избыточным.
В вашем конкретном случае, добавление секретного кода для вывода описания функции может быть удобным способом организации, но необходимо быть осторожным с выбором строки-кода, чтобы избежать возможных конфликтов или ошибок.
Как правило, в программировании рекомендуется делать код как можно более читаемым и понятным, поэтому если добавление описания внутрь функции поможет вам и другим разработчикам лучше понять ее функционал, то это может быть полезно.