Должны ли API быть в en_US или en_GB или в обоих? [закрыто]
9
Должен ли я писать API в орфографии США или Великобритании? Или я должен обеспечить сопоставление их обоих одному и внутренне с использованием любого, который мне нравится, чтобы они оба работали? В настоящее время большинство API-интерфейсов написано в США. Какое решение для этого?
редактировать: есть ли способ стандартизировать это. Может быть поддержка обоих?
API, предназначенные для международного использования EN-US. Поэтому, если вы намереваетесь предоставить свой API разработчикам по всему миру (или, по крайней мере, в нескольких странах, где британский английский не используется), вы должны использовать EN-US .
Локальные API
Конечно, небольшие API, ориентированные на конкретную страну, могут быть на языке этой страны. Но подумайте дважды об использовании EN-GB даже в этом случае:
Живя во Франции, я лично не оценил бы API по-французски; Английский просто легче использовать, когда дело доходит до разработки. Настройки локали делают просто странным писать на местном языке. Если вы видели исходный код с китайскими, немецкими или русскими названиями методов, вы поймете почему. То, что я сейчас вижу здесь слишком часто, - это исходный код, который смешивает французские имена с ударениями (é, ê, à и т. Д.), Французские имена без акцентов (что совершенно неверно и может вводить в заблуждение), английские имена и английский с орфографическими ошибками) ,
Использование EN-GB может усложнить использование API даже для британских разработчиков. Трудно запомнить, что мы должны писать Colorна C # или на PHP, но Colourв определенном API.
При создании локального API вы можете быть уверены, что он не станет известным на международном уровне через один, два или десять лет?
Одно замечание - когда-то был диалект языка Basic, в котором использовались ключевые слова буквального перевода на французский, хотя и с ограничениями ASCII («si», а не «if» и т. Д.). Вероятно, худшее в этом то, что это был Basic, а не французский.
Steve314
3
Я видел оба. API от британской компании использовал британскую английскую орфографию (например, «авторизация» вместо «авторизация»). Из-за отсутствия лучшего ответа я бы предложил согласовать соглашение, используемое на целевой платформе. Так, например, если вы используете платформенный класс «Color», вы не должны использовать «Color» в своем API.
Строго говоря, и «-ise», и «-ize» одинаково действительны в британском английском, хотя «-ise», вероятно, все еще более распространен. Одна из проблем британского разработчика заключается в том, чтобы помнить (а в некоторых случаях знать) различия в правописании. С инструментами поиска и замены и / или рефакторинга исправление обычно не должно быть большим делом, но иногда, вероятно, может быть. IIRC некоторый API, связанный с COM, имел две орфографии для одной функции из-за орфографической ошибки в первой версии - ошибка никогда не могла быть полностью удалена по причинам совместимости.
Я видел оба. API от британской компании использовал британскую английскую орфографию (например, «авторизация» вместо «авторизация»). Из-за отсутствия лучшего ответа я бы предложил согласовать соглашение, используемое на целевой платформе. Так, например, если вы используете платформенный класс «Color», вы не должны использовать «Color» в своем API.
источник