Из Википедии, свободной энциклопедии
Перейти к навигацииПерейти к поиску
WikiProject Computing  
WikiProject Информатика  

Соглашения о коде для языка программирования Java

Этот документ «Соглашения по коду для языка программирования Java» содержит стандартные соглашения, которым мы в Sun следуем и которые рекомендуем соблюдать другим. Он охватывает имена файлов, организацию файлов, отступы, комментарии, объявления, операторы, пробелы, соглашения об именах, методы программирования и включает пример кода. Зачем нужны соглашения о коде? Условные обозначения кода важны для программистов по ряду причин:

 * 80% стоимости программного обеспечения за весь срок службы идет на обслуживание. * Вряд ли какое-либо программное обеспечение поддерживается первоначальным автором на протяжении всей его жизни. * Условные обозначения кода улучшают читаемость программного обеспечения, позволяя инженерам быстрее и тщательнее понимать новый код.

Соглашения о коде для документа языка программирования Java были пересмотрены и обновлены 20 апреля 1999 г. [1]

Один класс на файл не обязательно. В Jave или C # иногда возникает необходимость объявить частные классы, которые должны совместно использовать исходные файлы с некоторыми другими общедоступными классами. G7shihao ( разговор ) 02:52, 20 февраля 2009 г. (UTC)

Привет, это комментарий 2009 года. Между тем, в основную статью добавлено несколько современных Java-соглашений. Закрытие этого комментария неспецифично, и на него не последовало больше ответов. Если я что-то пропустил, пожалуйста, откройте снова. KR  Выполнено 17387349L8764 ( разговорное ) 09:34, 15 апреля 2021 г. (UTC)

Завершающие запятые

Конечные запятые перенаправляют сюда, но в статье они не упоминаются. - Предыдущий беззнаковый комментарий добавлен 81.191.75.7 ( обсуждение ) 21:22, 29 июля 2015 г. (UTC)

Особого упоминания об этом не требуется. TC являются частью руководств по кодированию, например https://rules.sonarsource.com/c/RSPEC-878 KR  Выполнено 17387349L8764 ( обсуждение ) 09:39, 15 апреля 2021 г. (UTC)

Стиль программирования

Эта статья пересекается со стилем программирования и стандартами кодирования и не имеет надлежащей ссылки на de: Programmierstil. Я не осмеливаюсь его менять, потому что не могу решить, какая из двух статей может быть отправлена ​​в orcus или обе могут получить четкую другую лемму. - Брф ( доклад ) 15:46, 11 декабря 2009 г. (UTC)

Привет, это выглядит неаккуратно, да. В стиле программирования полностью отсутствуют референсы, что недопустимо для ИМО. Он был создан в 2003 году. Coding Conventions был создан в 2006 году и выглядит скорее как список. Я думаю, что это. Лучшие части стиля программирования должны быть объединены в соглашениях о кодировании, в подраздел «Стиль» или около того со свежими ссылками. Шокирует, что на этот комментарий раньше никто не ответил и не проявил интереса. Если найду время, вернусь к этому. BR 17387349L8764 ( разговор ) 09:43, 15 апреля 2021 (UTC)

Соглашения о рефакторинге кода и статьи о стилях программирования

Ниже приведены мои предложения по некоторым более крупным (но прямым) изменениям в указанных ниже 3 статьях. Не стесняйтесь их комментировать. Сейчас 5 ноября 2010 года, я не начну казнь, пока не пройдет несколько недель. Предложения по меньшим изменениям / слияниям в (в настоящее время) 3 задействованных статьях, я еще не изучал. Также здесь приветствуются любые предложения / комментарии. Спасибо, Ptrb ( обсуждение ) 07:09, 5 ноября 2010 г. (UTC).

Привет, правильно, обе страницы нужно объединить и обновить. См. Мой комментарий выше (раздел «Стиль программирования»). Я закрываю этот комментарий, который выглядит как повторяющийся призыв к действию. KR  Выполнено 17387349L8764 ( разговорное ) 09:44, 15 апреля 2021 г. (UTC)

Предложение 0

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

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

Ptrb ( разговорное ) 16:50, 3 ноября 2010 (UTC)

СОВЕРШЕНО , Ptrb ( обсуждение ) 08:27, 19 ноября 2010 г. (UTC)

Предложение 1

Содержимое, представленное здесь Programming_style # Appgotiable_names , более или менее эквивалентно содержимому, предоставленному здесь Naming_convention_ (программирование) #Business_value и здесь Naming_convention_ (программирование) #Length_of_identifiers . Я предлагаю

  1. удалите пример «получить ab c» и «получить часы, минуты, секунды» здесь Programming_style # Appgotiable_names и придерживаться Naming_convention_ (программирование) #Business_value
  2. подумайте о переносе утверждения «В ранних языках программирования» из Programming_style # Appgotiable_names сюда Naming_convention_ (программирование) #Length_of_identifiers

Ptrb ( обсуждение ) 14:52, 3 ноября 2010 (UTC)

СОВЕРШЕНО , Ptrb ( обсуждение ) 07:55, 17 ноября 2010 г. (UTC)

Предложение 2

Переместите этот раздел Coding_conventions # Common_conventions (который касается только вопросов именования) в эту статью Соглашение об именах (программирование) и превратите его в раздел уровня 1 под названием «Примеры» (или около того). Следующие остатки пока останутся в Coding_conventions # Common_conventions :

  1. В одной строке должно быть не более 80 символов, включая пробелы.
  2. В каждой строке должно быть только одно выражение.
  3. Дополнительный символ должен стоять в начале блока комментариев, чтобы ограничить начало публикуемой или обрабатываемой извне документации.

Ptrb ( обсуждение ) 16:36, 3 ноября 2010 (UTC)

СОВЕРШЕНО , Ptrb ( обсуждение ) 21:15, 17 ноября 2010 г. (UTC)

Предложение 3

Перенести полностью следующие разделы из раздела " Стиль программирования" в раздел " Соглашения о кодировании".

  1. Стиль_программирования # Внешние_ссылки
  2. Стиль_программирования # Coding_conventions_for_languages
  3. Programming_style # Coding_conventions_for_projects

Ptrb ( обсуждение ) 16:53, 3 ноября 2010 (UTC)

СОВЕРШЕНО , Ptrb ( обсуждение ) 07:50, 18 ноября 2010 г. (UTC)

Предложение 4

Рядом с общей статьей о Соглашении об именах (программирование) ,

  • Существует категория Категория: Соглашения об именах , к которой можно (и нужно?) Отнести соответствующие статьи.
  • Есть несколько статей, которые касаются конкретных соглашений об именах, здесь следует убедиться, что соглашение об именах (программирование) не содержит (слишком большой) избыточности и, скорее, ссылается на эти статьи.

В настоящее время (5 ноября 2010 г.) размещены следующие статьи:

Ptrb ( обсуждение ) 14:08, 5 ноября 2010 (UTC)

Предложение 5

СОВЕРШЕНО , Ptrb ( обсуждение ) 08:26, 19 ноября 2010 г. (UTC)

Предложение 6

  • Улучшите раздел Coding_conventions # Common_conventions , возможно, превратите его в своего рода раздел «см. Также», указав на
    • соглашения об именах
    • соглашения о макете / стиле
    • Другой? условности
СОВЕРШЕНО , Ptrb ( обсуждение ) 08:26, 19 ноября 2010 г. (UTC)

Соглашения о рефакторинге кода и статьи о стилях программирования - Краткое изложение подготовительных мероприятий и внесенных изменений

Если вам стоит это посмотреть, пожалуйста, дайте мне немного времени, чтобы записать мои опасения и предложения.

  1. Изменено перенаправление в стандарте кодирования, чтобы указать на соглашения о кодировании - Ptrb (обсуждение) 16:15, 3 ноября 2010 г. (UTC)
  2. Изменено перенаправление в стандартах кодирования, чтобы указать на соглашения о кодировании - Ptrb (обсуждение) 16:15, 3 ноября 2010 г. (UTC)
  3. Изменено соглашение о перенаправлении в коде, чтобы указать на соглашения о кодировании - Ptrb (обсуждение) 16:15, 3 ноября 2010 г. (UTC)
  4. Изменено перенаправление в соглашениях о коде, чтобы указать на соглашения о кодировании - Ptrb (обсуждение) 16:15, 3 ноября 2010 г. (UTC)
  5. На стиле программирования Добавлено слияние-коды для кодирования конвенции и Соглашения об именах (программирование) - Ptrb (Обсуждение) 16:15, 3 ноября 2010 (UTC)
  6. О соглашениях о кодировании Добавлено соглашение об именовании кода слияния (программирование) - Ptrb (обсуждение) 16:15, 3 ноября 2010 г. (UTC)
  7. О соглашениях о кодировании Добавлен стиль программирования с слиянием из кода - Ptrb (обсуждение) 16:15, 3 ноября 2010 г. (UTC)
  8. О соглашении об именах (программирование) Добавлены коды слияния для соглашений о кодировании и стиля программирования - Ptrb (обсуждение) 16:15, 3 ноября 2010 г. (UTC)
  9. Добавлен раздел предложений Обсуждение: Coding_conventions # Proposal_0 - Ptrb ( talk ) 22:18, 3 ноября 2010 г. (UTC)
  10. Добавлен раздел предложений Talk: Coding_conventions # Proposal_1 - Ptrb ( talk ) 22:18, 3 ноября 2010 г. (UTC)
  11. Добавлен раздел предложения Обсуждение: Coding_conventions # Proposal_2 - Ptrb ( talk ) 22:18, 3 ноября 2010 г. (UTC)
  12. Добавлен раздел предложений Talk: Coding_conventions # Proposal_3 - Ptrb ( talk ) 22:19, 3 ноября 2010 г. (UTC)
  13. В разделе « Соглашение об именах (программирование) » в разделе «См. Также» добавьте явный указатель на Категория: Соглашения об именах - Ptrb ( обсуждение ) 14:19, 5 ноября 2010 г. (UTC)
  14. Выполнено / ВЫПОЛНЕНО Обсуждение: Coding_conventions # Proposal_1 - Ptrb ( обсуждение ) 07:58, 18 ноября 2010 г. (UTC)
  15. Выполнено / ВЫПОЛНЕНО Обсуждение: Coding_conventions # Proposal_2 - Ptrb ( talk ) 07:58, 18 ноября 2010 г. (UTC)
  16. Выполнено / ВЫПОЛНЕНО Обсуждение: Coding_conventions # Proposal_3 - Ptrb ( talk ) 07:58, 18 ноября 2010 г. (UTC)
  17. Добавлено обсуждение: Coding_conventions # Proposal_5 - Ptrb ( talk ) 07:58, 18 ноября 2010 г. (UTC)
  18. Добавлено обсуждение: Coding_conventions # Proposal_6 - Ptrb ( talk ) 07:58, 18 ноября 2010 г. (UTC)
  19. Выполнено / ВЫПОЛНЕНО Обсуждение: Coding_conventions # Proposal_5 - Ptrb ( talk ) 08:27, 19 ноября 2010 г. (UTC)
  20. Выполнено / ВЫПОЛНЕНО Обсуждение: Coding_conventions # Proposal_6 - Ptrb ( talk ) 08:27, 19 ноября 2010 г. (UTC)
  21. Выполнено / ВЫПОЛНЕНО Обсуждение: Coding_conventions # Proposal_0 - Ptrb ( talk ) 08:27, 19 ноября 2010 г. (UTC)

Осмысленность и последовательность

«Если в цикле for используется только буква« i »для индекса, это не имеет особого смысла. Однако если используется слово« индекс », это имеет гораздо большее значение».

Меня всегда учили использовать «i» в качестве индекса. Это довольно стандартное соглашение (а также использование j, k и т. Д. Для последующих вложенных циклов), и большинство людей, которые видят «i = 0» в строке кода, мгновенно связывают его с предстоящим циклом.

Использование index можно считать подробным.

41.133.164.39 ( разговорное ) 20:53, 6 июня 2013 (UTC) Дитер


Значимые имена?

Откуда берутся эти «значащие имена»?

Какие-нибудь мысли, правила, практики, что можно, а что нельзя делать в отношении "значимых имен"? DEddy ( разговор ) 21:31, 12 июля 2013 (UTC)

Привет, поиск по статье "Значимые имена" дал 0 результатов. Что ты имеешь в виду? Я закрываю это, на ваш комментарий какое-то время не было ответа. Пожалуйста, откройте снова, если необходимо. KR  Выполнено 17387349L8764 ( разговорное ) 09:48, 15 апреля 2021 г. (UTC)
Имя должно описывать данные в терминах, понятных пользователю приложения. Например, «sample_size» или «median_age» вместо «x», «ss» или «med». Помимо этого, есть много мыслей о том, какой должна быть форма имени, например, «pszCustomerName» - это венгерская нотация для указателя (p) на строку с завершающим нулем (sz), содержащую имя клиента. Питер Фласс ( разговор ) 19:14, 15 апреля 2021 (UTC)

Неработающая ссылка для справки 1

Ссылка ведет только на страницу с неработающим llnk, ее нужно обновить. - Предыдущий неподписанный комментарий добавлен 199.243.65.6 ( обсуждение ) 21:37, 6 мая 2014 г. (UTC)

Пожалуйста, помогите и обновите его. Ваш комментарий от 2014 года, это слишком давно. Ссылка 1 в настоящее время работает. BR  Выполнено 17387349L8764 ( разговорное ) 09:46, 15 апреля 2021 г. (UTC)

Внешние ссылки изменены

Привет, друзья Википедии,

Я только что изменил одну внешнюю ссылку на Соглашения о кодировании . Пожалуйста, найдите время, чтобы просмотреть мою правку . Если у вас есть какие-либо вопросы или вам нужно, чтобы бот игнорировал ссылки или страницу в целом, посетите этот простой FAQ для получения дополнительной информации. Я внес следующие изменения:

  • Добавлен тег к http://www.dit.upm.es/ork/documents/adahis.pdf{{dead link}}
  • Добавлен архив https://web.archive.org/web/20100527142102/http://software.gsfc.nasa.gov/AssetsApproved/PA2.4.1.1.1.pdf в http://software.gsfc.nasa.gov/ AssetsApproved / PA2.4.1.1.1.pdf
  • Добавлен тег на ftp://ftp.estec.esa.nl/pub/wm/wme/bssc/bssc983.pdf{{dead link}}

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

Это сообщение было опубликовано до февраля 2018 г. После февраля 2018 г. разделы страницы обсуждения «Изменены внешние ссылки» больше не создаются и не отслеживаются InternetArchiveBot . В отношении этих уведомлений на странице обсуждения не требуется никаких специальных действий, кроме регулярной проверки с использованием приведенных ниже инструкций инструмента архивации. Редакторы имеют разрешение удалить эти разделы «Внешние ссылки изменены» на странице обсуждения, если они хотят убрать беспорядок на страницах обсуждения, но перед массовым систематическим удалением просматривают RfC . Это сообщение динамически обновляется с помощью шаблона (последнее обновление: 15 июля 2018 г.) .{{sourcecheck}}

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

Ура. - InternetArchiveBot ( Сообщить об ошибке ) 05:26, 10 августа 2017 г. (UTC)

Внешние ссылки изменены

Привет, друзья Википедии,

Я только что изменил одну внешнюю ссылку на Соглашения о кодировании . Пожалуйста, найдите время, чтобы просмотреть мою правку . Если у вас есть какие-либо вопросы или вам нужно, чтобы бот игнорировал ссылки или страницу в целом, посетите этот простой FAQ для получения дополнительной информации. Я внес следующие изменения:

  • Добавлен архив https://web.archive.org/web/20061215120657/http://www.xprogramming.com/xpmag/whatisxp.htm на http://www.xprogramming.com/xpmag/whatisxp.htm

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

Это сообщение было опубликовано до февраля 2018 г. После февраля 2018 г. разделы страницы обсуждения «Изменены внешние ссылки» больше не создаются и не отслеживаются InternetArchiveBot . В отношении этих уведомлений на странице обсуждения не требуется никаких специальных действий, кроме регулярной проверки с использованием приведенных ниже инструкций инструмента архивации. Редакторы имеют разрешение удалить эти разделы «Внешние ссылки изменены» на странице обсуждения, если они хотят убрать беспорядок на страницах обсуждения, но перед массовым систематическим удалением просматривают RfC . Это сообщение динамически обновляется с помощью шаблона (последнее обновление: 15 июля 2018 г.) .{{sourcecheck}}

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

Ура. - InternetArchiveBot ( Сообщить об ошибке ) 10:00, 20 сентября 2017 г. (UTC)