Можно ли в пользовательские функции запихивать описания этих же функций? Не будет ли это дурным тоном?

Question

[baksovnet]

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

Comments

[Дмитрий Кузнецов]

Отредактируйте задачу, воспользовавшись тэгом code.

Answer 1

[Владимир Скибин]

А это тогда для чего?
https://ru.wikipedia.org/wiki/PHPDoc

Answer 2

[Иван]

Для этого существуют комментарии и стандарты комментирования PHP-кода, которые поддерживают многие IDE. И да, это будет дурным тоном.