Есть ли рекомендации по стилю для именованных параметров в C #?

Question

MSDN - пробелы после двоеточия. Это отличается от Objective-C, где я не вижу людей, использующих пробел после двоеточия. Я думаю, что это может быть проблемой, когда подсветка синтаксиса еще не дошла до этой функции, но у меня нет опыта в хорошей IDE. MonoDevelop, который я использую на Mac с Unity, не обеспечивает подсветку синтаксиса и автозаполнение для именованных параметров. Там много всего ; если вы знаете, что я прошу существовать внутри или в другом месте, пожалуйста, дайте мне знать. Я еще не нашел его.

Answer 1

У Microsoft есть несколько руководств по здравому смыслу, опубликованных на MSDN, на мой взгляд, это единообразие, которое имеет такое же значение, как и соглашение. Если вы этого еще не сделали, стоит посмотреть на Stylecop для определения стиля кода и стандартов.

Руководство по именам

От: Имена параметров

Выбор правильных имен параметров может значительно улучшить удобство использования вашей библиотеки. Хорошее имя параметра должно указывать, какие данные или На функциональность влияет параметр.

Использовать верблюжий корпус в именах параметров. Используйте описательный параметр имена.

В большинстве случаев имя параметра и его тип должны быть достаточно для определения использования параметра.

Рассмотрите возможность использования имен, основанных на значении параметра, а не на именах в зависимости от типа параметра.

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

Answer 2

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

Однако, ИМХО, он более читабелен, когда вы используете только один пробел после двоеточия.

Answer 3

Руководства по стилю должны исходить от команды разработчиков.Каждый язык имеет свои собственные идиомы, которым нужно следовать, но команда должна определить детали.То же самое относится и к соглашениям об именах.

Запишите их, разошлите и получите согласие каждого.Если вы работаете с открытым исходным кодом, я уверен, что сообщество предоставит вам обратную связь.