좋은 품질의 코멘트가 포함 된 오픈 소스 프로젝트를 권장하십시오.

Question

영어는 모국어가 아닙니다. 그러나 영어로 의견을 써야합니다. 좋은 영어로 코멘트 된 코드를 공부함으로써 "영어 코멘트"를 향상시키고 싶습니다. 뛰어난 언어 명령을 가진 사람들이 작성한 많은 의미있는 의견을 담은 오픈 소스 프로젝트를 추천하십시오.

Answer 1

Simon Tatham의 퍼즐 컬렉션을 추천 해드립니다.

내가 읽은 의견은 올바른 영어처럼 보입니다. 또한, 그들은 명확하게 쓰여지고 왜 일이 어떻게 완료되었는지에 대한 유용한 정보를 포함합니다.

개발자 설명서는 읽기 쉽고 이해하기 쉽습니다. 또한 부작용으로 시스템 아키텍처가 우수하고 단순한 설명서를 읽게 될 것입니다.

왜 뭔가를 읽은 다음 그 이유를 명시 적으로 이해하지 않고 그것을 에뮬레이트하는 것이 좋은 생각이라면 ST의 퍼즐을 확실히 추천 할 수 있습니다. 좋은 글쓰기에 대한 명확한 이해를 원한다면 ST의 퍼즐이 예 :으로 제공 될 것이라고 생각하지만, 실제로 Strunk and White와 같은 것을 읽고 싶습니다.

Answer 2

이 스타일을 에뮬레이션해야한다고해도 의견을 말할 수있는 좋은 장소라고 생각하지 않습니다. 코멘트는 종종 정확하지 않습니다. 영어와 좋은 프로젝트는 어쨌든 너무 많은 코멘트를 가지지 않으므로 배울 점이 많지 않습니다.

반면에 광범위하게 주석 처리 된 프로젝트를 사용한다면 프로그래머가 간결한 의미를 전달할 수 없기 때문에 위대한 역할 모델이 아니라는 것을 거의 확신 할 수 있습니다. 이것은 일반화입니다. 그러나, 나는 그것이 (거의?) 항상 사실이라고 믿습니다. YMMV.

대신 전문가를 통해 영어를 배우십시오. 이에 대해 a question이 발생했습니다. 나는 “On Writing Well” by William Zinsser을 추천했고 나는 다시 그렇게 할 것이다.

나는 오직 그것의 작은 조각을 검토 한

Answer 3

(그런데, 영어. 중 모국어되지 않습니다)하지만 리눅스 커널이 아주 잘 주석 들었어요.

Answer 4

나는 항상 Angband이 잘 작성되었다고 생각했습니다.

Answer 5

나는 꽤 잘 오픈 소스 프로젝트는 드루팔 (Drupal이다. 확인 : Drupal.org. 필자는 여러 개의 포털을 개발했으며 실제로 모듈과 테마의 주석을 읽음으로써 많은 것을 배울 수 있습니다. 실제로 그들은 언젠가는 문서화 된 정보를 얻는다.

Answer 6

Minix은 아주 잘 설명되어 있습니다. 어떤 곳에서는 약간 간결하지만 댓글은 매우 유용합니다.

Answer 7

또한 글쓰기를 개선하고 싶다면 ... 영어에 관해 많은 혼란스러운 것들이 있습니다. 당신이이 점들을 어떻게 마스터하는지는 훌륭한 작가와 평범한 작가를 구별하는 것입니다. 최상, 가장 작고 가장 간결한 책 (모두에게 사본이 있어야 함)은 Elements of Style by Strunk and White입니다. Amazon에서 2 달러를 얻을 수 있습니다. 가장 좋은 $ 2 지출!