두 번째 또는 세 번째 사람의 의견?

Question

2 인칭 또는 3 인칭으로 댓글을 씁니까?

// go somewhere and do something (2nd person comment) 

또는

// goes somewhere and does something (3rd person comment) 

Answer 1

확실히 3 자 스타일.

Answer 2

가 나는 종종 의사의 스타일을 말하는 경향이

// Now we take $x and check whether it's valid for this pass 

Answer 3

한 유용한 팁 : 각 주석 유지하려고 가능한 한 자기 - 포함되어 있습니다. 예를 들어,이 형태는 :

// First, mumble the frabbitz. 

blah blah 

// Second, foobar the quux 

blah blah 

이것은 좋은 이야기이지만, 열심히 코드를 편집 할 수 있습니다, "첫"와 "두 번째"부분이 잘못 될 수 있기 때문이다. 결국, 그들은 코멘트에 그다지 첨가하지 않지만, 그것들을 연약한 방식으로 상호 연관시킨다.

Answer 4

은 가끔 그것은 많은 사람들이 코드를 편집하는 방법에 어떤 목적으로 의존 수도

/* 
Usage: 
set_position(0.5, 0.5); // im in the center 
set_position(0.0, 1.0); // im in the lower,left corner 
*/ 

Answer 5

처럼, 첫번째 사람에 말한다. 그럼에도 불구하고 공개적으로 볼 수있는 내 자신의 코드에서 개인적인 의견을 자유롭게 추가 할 수 있습니다. 아마도 '나'를 사용했을 것입니다. 공동 프로젝트에서 의견은 공동체 스타일을 목표로해야하며 '나'는 제자리에 없을 수 있습니다.

주석이 깨지기 쉽고 많은 현대 기관 (예 : 코드 삭제)은 기능 및 필드가 의미있는 이름을 가져야한다고 제안합니다. 그러나 물론, 설명 적 주석이 여전히 중요시되는 곳이 많이 있습니다.

Answer 6

내 견해는 가장 편안하게 느끼는 스타일을 사용해야한다는 것입니다.

포함 된 의견은 귀하와 귀하의 코드 구현 세부 사항을 이해하려고 시도하는 다른 개발자가 읽고 자 의도로 작성되었습니다. 명확하고 이해하기 쉬운 한, 스타일이 조금 이상하거나, 문법이 조금 나쁘거나, 맞춤법 오류가 약간 있습니다. 그것을 읽는 사람들은 그런 것들을 돌보는 것 이상이어야합니다.

API 문서를 만들기 위해 추출 된 주석은 스타일, 문법 및 철자법에 대한 좀 더주의를 기울일 자격이 있습니다. 그러나 여기서도 정확성과 완성도가 훨씬 더 중요합니다.