Если изменение задокументированной производительности метода считается критическим изменением ? [закрыто]

Закрыт . Этот вопрос основан на мнении . В настоящее время он не принимает ответы.

Хотите улучшить этот вопрос? Обновите вопрос, чтобы на него можно было ответить с помощью фактов и цитат, отредактировав это сообщение .

Закрыто в прошлом году .

Кажется, что обычным правилом в разработке программного обеспечения является то, что после развертывания общедоступного API, особенно , если вы задокументировали этот API (который - да, у вас должен быть), вы должны долго думать и трудно перед внесением каких-либо изменений, которые могут нарушить обратную совместимость с этим API, поскольку такие изменения будут критическими изменениями . На самом деле я уверен, что многие разработчики возразят, что вы просто категорически не должны этого делать, независимо от того, как долго и усердно вы об этом думаете.

Иногда разработчик фактически документирует производительность метода. Многие документы MSDN делают это, например, используя нотацию Big O . Будет ли изменение этого также представлять собой «критическое» изменение? Может быть, это не ясный вопрос; Перефразируй: следует ли этого избегать?

Мне кажется, что в тех случаях, когда, например, вы могли бы разработать более совершенный алгоритм для решения проблемы, если бы вы ранее задокументировали, что этот алгоритм был O (N ²) вы могли бы быть прощены за улучшение вашего API, заменив его более совершенным алгоритмом, который, скажем, равен O (log N). Пользователи вашего API могут это заметить и, я полагаю, будут только рады улучшениям.

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

Моя интуиция подсказывает мне, что улучшение производительности почти всегда нормально. А как насчет противоположного? Это нормально, если вы обновите свою документацию? Это просто неправильно? Я просто ищу здесь разумные рекомендации.

задан Dan Tao 25 January 2011 в 22:49

0 ответов

Другие вопросы по тегам:

performance api language-agnostic documentation backwards-compatibility

Если изменение задокументированной производительности метода считается критическим изменением ? [закрыто]

0 ответов

Похожие вопросы: