Como faço para nomear este método simples?

Question

Em primeiro lugar, isso não é realmente uma questão de programação. É mais uma questão de "convenções como faço para satisfazer McConnels nomeação?"

Eu tenho essa Delphi-aplicativo que manipula palavra-documentos. Uma das coisas que eu preciso fazer é percorrer todos os indicadores no documento e excluir alguns deles com base em uma regra simples: Se eu atualmente trabalho em uma citação que irá apagar todos os marcadores onde o nome começa com "cw_orderspecific". Se eu trabalhar em uma confirmação do pedido I irá remover todos os marcadores com nomes começando com "cw_quotespecific".

O método está no lugar, e tudo funciona perfeitamente, mas eu tenho um pequeno problema. O que devo chamar meu método? O nome atual ( "DeleteBookmarksNotAllowedForCurrentDocumentType") é muito longo.

Todas as sugestões?

Answer 1

DeleteNonRelevantBookmarks?

Answer 2

Alterar a função de tomar o prefixo para apagar, e chamá-lo DeleteBookmarksWithPrefix:

DeleteBookmarksWithPrefix("cw_quotespecific")

ou

DeleteBookmarksWithPrefix(otherWorkTypePrefix)

Isso faz com que o código muito legível, e faz a função reutilizável em outras circunstâncias, ao invés de somente sempre ser útil para uma tarefa muito específica.

Note que se você nunca vai ter um terceiro tipo de trabalho, você pode querer inverter o sentido dele:

DeleteBookmarksWithoutPrefix(currentWorkTypePrefix)

Answer 3

Como suma, você quer que ele seja? Meu primeiro instinto é para soltar algumas palavras que não parecem tão importantes. Como DeleteBookmarksNotAllowedForDocumentType, DeleteBookmarksNotAllowedForDocument, ou simplesmente DeleteBookmarksNotAllowed. Embora eu provavelmente preferiria algo como DeleteInvalidBookmarks. Claro que isso só funciona se não há outros métodos que bookmarks APAGAR por regras diferentes.
Ou se você está disposto a mudar a maneira de funções de método, eu torná-lo mais genérico, dando o prefixo como um parâmetro, em seguida, a nomeação seria mais simples.

Answer 4

Use acrônimos? Definir em comentários que CDT é "Current Tipo de Documento", e você vai ter DeleteBookmarks_NotAllowedForCDT. bastante curto.

Answer 5

DelBookmarksStartingWith Que tal? É muito clara e expressa intenção.