Пожалуйста, порекомендуйте проект с открытым исходным кодом с качественными комментариями на хорошем английском - PullRequest
3 голосов
/ 30 октября 2008

Английский не мой родной язык. Тем не менее, я должен написать комментарии на английском языке. Я хочу улучшить свой «английский комментарий», изучая фрагмент кода, который комментируется на хорошем английском языке. Пожалуйста, порекомендуйте проект с открытым исходным кодом, который содержит много значимых комментариев, написанных людьми с отличным знанием языка.

Ответы [ 7 ]

2 голосов
/ 30 октября 2008

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

Если, с другой стороны, вы берете проект, который подробно комментируется, вы можете быть почти уверены, что он не является хорошим примером для подражания, поскольку программисты были неспособны передать краткий смысл. Это обобщение, конечно. Тем не менее, я считаю, что это (почти?) Всегда правда. YMMV.

Вместо этого учите английский, изучая экспертов. Был вопрос по этому поводу. Я рекомендовал «О том, как хорошо писать» Уильяма Цинссера , и я сделаю это снова.

(Кстати, английский тоже не мой родной язык.)

2 голосов
/ 11 февраля 2009

Я могу порекомендовать коллекцию головоломок Саймона Тэтхэма.

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

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

Если вы хотите что-то прочитать, а затем эмулировать, не понимая, почему это хорошая идея, я определенно могу порекомендовать головоломки ST. Если вы хотите четко понять, что такое хорошее письмо, я думаю, что головоломки ST послужат хорошим примером , но вы действительно хотите прочитать что-то вроде Strunk and White.

0 голосов
/ 30 октября 2008

Кроме того, если вы хотите улучшить свое письмо ... В английском языке есть много запутанных вещей. То, как вы справляетесь с этими вопросами, отличает посредственного писателя от прекрасного писателя. Лучшая, самая маленькая и краткая книга (у каждого должна быть копия!) Называется Elements of Style от Strunk и White . Обратите внимание, что вы можете получить его за 2 доллара на Amazon. Лучшие 2 доллара, которые вы потратите!

0 голосов
/ 30 октября 2008

Minix довольно хорошо прокомментирован. В некоторых местах они могут быть немного краткими, но комментарии очень полезны.

0 голосов
/ 30 октября 2008

Я довольно хорошо прокомментировал проект с открытым исходным кодом - Drupal. Проверьте это на Drupal.org . Я разработал несколько порталов, и вы можете узнать немало, читая комментарии в модулях и темах. На самом деле они в несколько раз более информативны, чем документация.

0 голосов
/ 30 октября 2008

Я всегда думал, Angband хорошо прокомментировано.

0 голосов
/ 30 октября 2008

Я только когда-либо смотрел на него, но слышал, что ядро ​​Linux очень хорошо прокомментировано.

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...