Наименование темы / комментария функций / методов - PullRequest
4 голосов
/ 01 января 2011

Я смотрел на американский язык жестов на днях ... и заметил, что построение языка было комментарием к теме.Как и в «Погода хорошая».Это заставило меня задуматься о том, почему мы называем методы / функции следующим образом:

function getName() { ... }
function setName(v) { ... }

Если мы подумаем о присвоении имен в функции комментария к теме, имена функций будут

function nameGet() { ... }
function nameSet() { ... }

Это может быть лучше, если у класса несколько целей.IE:

class events {
    function ListAdd();
    function ListDelete();
    function ListGet();

    function EventAdd();
    function EventDelete();
    function EventGet();
}

Таким образом, функции сгруппированы по «теме».Где, как и в предыдущем названии, функции сгруппированы в Action-Noun, но отсортированы по существительным.

Я подумал, что это интересный POV, что другие люди думают о именовании функций / методов Topic-Comment?

Очевидно, что смешивать соглашения об именах в одном проекте было бы странно, но в целом?

Ответы [ 2 ]

1 голос
/ 01 января 2011

Современные методы ООП должны позволять нам не указывать предмет нашей функции, а только действие, например, для

.

Ваш класс событий должен иметь только add / delete / get, и у вас должен быть отдельный класс Event_List, который также имеет add / delete / get.

так, в зависимости от языка это будет называться event_obj.get(), или event_obj.delete() ... и т. Д.

как event_list_obj.add() и т.д ...

Это на самом деле согласуется с тем, что вы сказали о языке жестов, что очень хорошо.

0 голосов
/ 01 января 2011

Я собираюсь рискнуть предположить и сказать, что ваш класс событий должен иметь объект «Список», который имеет добавление, получение и удаление, наряду с его собственными добавлением, получением и удалением. Я считаю это излишним, когда вы видите имя класса, повторяемое в его методах.

...