LINUX.ORG.RU

История изменений

Исправление www_linux_org_ru, (текущая версия) :

Ты издеваешься? Я специально говорю об особом случае когда параметров много и/или имена у них длинные. И такие случаи, наверняка, будут.

?

что тебе не понравилось в функциях do_something_interesting и select_log_enties?

С документированием параметров идея интересная

тут eao197 тебе явно бы сказал что-нить резкое про тех, кто их не документирует

хотя я считаю, что большей частью у хорошо спроектированной функции каждый отдельный параметр не должен документироваться текстом (а только типом данных); тем не менее *удобное* место для того, чтобы плюхнуть доку на параметр (не меняя форматирования всей функции) быть должно

кстати, иногда текст все же нужен, т.к. не очевидно, почему на параметр наложено какое-то ограничение

но со своими недостатками.

какими?

Если делать в лоб, то в случае когда про параметры много писать надо, код уж слишком растянется.

и в чем здесь проблема?

скорее наоборот — проблема это когда комменты к функции лежат где-то вне ее тела

Исправление www_linux_org_ru, :

Ты издеваешься? Я специально говорю об особом случае когда параметров много и/или имена у них длинные. И такие случаи, наверняка, будут.

?

что тебе не понравилось в функциях do_something_interesting и select_log_enties?

С документированием параметров идея интересная

тут eao197 тебе явно бы сказал что-нить резкое про тех, кто их не документирует

хотя я считаю, что большей частью у хорошо спроектированной функции каждый отдельный параметр не должен документироваться текстом (а только типом данных); тем не менее *удобное* место для того, чтобы плюхнуть доку на параметр (не меняя форматирования всего текста) быть должно

кстати, иногда текст все же нужен, т.к. не очевидно, почему на параметр наложено какое-то ограничение

но со своими недостатками.

какими?

Если делать в лоб, то в случае когда про параметры много писать надо, код уж слишком растянется.

и в чем здесь проблема?

скорее наоборот — проблема это когда комменты к функции лежат где-то вне ее тела

Исправление www_linux_org_ru, :

Ты издеваешься? Я специально говорю об особом случае когда параметров много и/или имена у них длинные. И такие случаи, наверняка, будут.

?

что тебе не понравилось в функциях do_something_interesting и select_log_enties?

С документированием параметров идея интересная

тут eao197 тебе явно бы сказал что-нить резкое про тех, кто их не документирует

хотя я считаю, что большей частью у хорошо спроектированной функции каждый отдельный параметр не должен документироваться текстом (а только типом данных); тем не менее *удобное* место для того, чтобы плюхнуть доку на параметр быть должно)

кстати, иногда текст все же нужен, т.к. не очевидно, почему на параметр наложено какое-то ограничение

но со своими недостатками.

какими?

Если делать в лоб, то в случае когда про параметры много писать надо, код уж слишком растянется.

и в чем здесь проблема?

скорее наоборот — проблема это когда комменты к функции лежат где-то вне ее тела

Исходная версия www_linux_org_ru, :

Ты издеваешься? Я специально говорю об особом случае когда параметров много и/или имена у них длинные. И такие случаи, наверняка, будут.

?

что тебе не понравилось в функциях do_something_interesting и select_log_enties?

С документированием параметров идея интересная

тут eao197 тебе явно бы сказал что-нить резкое про тех, кто их не документирует

хотя я считаю, что большей частью у хорошо спроектированной функции каждый отдельный параметр не должны документироваться текстом (а только типом данных); тем не менее *удобное* место для того, чтобы плюхнуть доку на параметр быть должно)

кстати, иногда текст все же нужен, т.к. не очевидно, почему на параметр наложено какое-то ограничение

но со своими недостатками.

какими?

Если делать в лоб, то в случае когда про параметры много писать надо, код уж слишком растянется.

и в чем здесь проблема?

скорее наоборот — проблема это когда комменты к функции лежат где-то вне ее тела