Как я называю этот простой метод?

Question

Прежде всего, это не на самом деле вопрос программирования. Это больше вопрос о том, «как мне удовлетворить соглашения об именах McConnels?»

У меня есть Delphi-приложение, которое манипулирует текстовыми документами. Одна из вещей, которые мне нужно сделать, - это просмотреть все закладки в документе и удалить некоторые из них на основе простого правила: если я сейчас работаю над цитатой, я удаляю все закладки, имя которых начинается с "cw_orderspecific". Если я работаю над подтверждением заказа, я удаляю все закладки с именами, начинающимися с "cw_quotespecific".

Метод на месте, и все работает отлично, но у меня есть крошечная проблема. Как мне назвать мой метод? Текущее имя («DeleteBookmarksNotAllowedForCurrentDocumentType») слишком длинное.

Есть предложения?

Answer 1

Измените функцию, чтобы взять префикс для удаления и вызвать его DeleteBookmarksWithPrefix:

DeleteBookmarksWithPrefix("cw_quotespecific")

или

DeleteBookmarksWithPrefix(otherWorkTypePrefix)

Это делает код очень читабельным и делает функцию многократно используемой при других обстоятельствах, а не только когда-либо полезной для одной очень конкретной задачи.

Обратите внимание, что если у вас когда-нибудь будет третий тип работы, вы, возможно, захотите изменить его смысл:

DeleteBookmarksWithoutPrefix(currentWorkTypePrefix)

Answer 2

Как коротко вы хотите, чтобы это было? Мой первый инстинкт - отбросить слова, которые не кажутся такими важными. Например DeleteBookmarksNotAllowedForDocumentType, DeleteBookmarksNotAllowedForDocument или просто DeleteBookmarksNotAllowed. Хотя я бы предпочел что-то вроде DeleteInvalidBookmarks. Конечно, это работает, только если нет других методов, которые удаляют закладки по другим правилам.
Или, если вы хотите изменить способ работы метода, я бы сделал его более универсальным, указав префикс в качестве параметра, тогда наименование будет проще.

Answer 3

Удалить не релевантные закладки?

Answer 4

Как насчет DelBookmarksStartingWith? Это довольно ясно и выражает намерение.

Answer 5

Использовать аббревиатуры? Определите в комментариях, что CDT - «Текущий тип документа», и вы получите DeleteBookmarks_NotAllowedForCDT. Достаточно короткий.