February 17, 2021

Метафоры в названиях

Когда сложно придумать короткое название, попробуйте придумать метафору.

Как назвать параметры функцииstrstr, которая ищет строку в строке?

На https://www.cplusplus.com/reference/cstring/strstr/ не заморачивались. Каждый раз теперь придется смотреть документацию, чтобы вспомнить, что в чем ищется:

const char * strstr ( const char * str1, const char * str2 );

Для этого случая есть известная метафора, например, на https://man7.org/linux/man-pages/man3/strstr.3.html:

char *strstr(const char *haystack, const char *needle);

Или на https://en.cppreference.com/w/cpp/string/byte/strstr:

const char* strstr( const char* haystack, const char* needle );

Или даже в PHP на https://www.php.net/manual/en/function.strstr.php:

strstr ( string $haystack , string $needle , bool $before_needle = false ) : string|false