다른 사람들의 코드를보고 자신의 의견에 스타일을 적용하는 것이 좋으며, 대부분의 사람들은 * 및 ////을 사용합니다. 물론 언어에 따라 다르지만, 나는 좋은 방법과 나쁜 방법을 분명히 보았습니다. 코딩 된 페이지는 실제로 올바른 주석 구조와 함께 나타날 수 있으며 아무 지식없이 프로젝트에 들어오는 사람이 쉽게 읽을 수있게 해줍니다.코멘트 스타일 갤러리 ... 댓글 작성 방법 게시글
저는 사람들이 HTML, PHP 또는 기타 다른 것들에 대한 주석, 섹션 구분 등의 가장 좋은 방법이라고 생각하는 것이 궁금합니다.
PHP :
개인적으로 나는 방법/기능 내부의 모든 것에 //을 사용합니다. 어떤 사람이 /* */을 사용하면 코드 블록을 주석 처리하기가 더 어려워 지므로 귀찮습니다.
필자는 설명서 목적으로 javadoc과 매우 유사한 phpdoc을 사용합니다. 어떤 의견없이 15 ~ 20 개 라인을 가면
/**
* Overall description
* @keyword - description
*/
은 일반적으로 좋은 규칙은, 당신은 코드가 진정으로 자기 설명되지 않는 일부 의견에 둘 필요가있다. 그 당시에는 500 라인 기능과 모든 기능을 기억할 것입니다. 다른 사람이 들어 와서 코드를 이해하려고하면 코드가 더 어려워집니다!
측면 노드 (빠른 링크하지 광산) : http://www.heartysoft.com/ninja-coding-code-comments
왜 내가 의견을 좋아하지 않는다는
내 코드를 주석 피하기 위해 노력하고있어 주된 이유는 개념이다 자체 설명 코드 코드는 자명해야합니다. 코드를 읽는 사람 은 어떤 일이 벌어지고 있는지 이해해야합니다 (일부 도메인 지식이 있어야 함). 의 상황을 설명하기 위해 의견에 의존하는 것은 좋은 생각이 아닙니다. 코드는 개의 댓글이 업데이트되는 것보다 훨씬 자주 변경 될 것입니다. 팀의 경계가 아무리 중요하더라도 이건 입니다. 기껏해야, 이것은 약간 구식 인 코멘트가 될 수 있습니다. 최악의 경우, 오래된 코드는 코드가 실제로 무엇을하는지에 대해 오도 된 것일 수 있습니다. .
-
나는 항상 추가 설명이 필요하지 않도록 내 코드를 리팩토링하는 것을 시도하고있다.
결국 나는 APIDoc을 자동 생성하기위한 일반적인 xDoc 주석 이상의 것을 가지고 끝난다. 이러한 주석조차도 대부분 자동 생성 될 수 있습니다.
예를 들어 OS 별 문제로 문제를 논의하고 공개 된 링크를 추가하는 공개 웹 사이트를 찾으려고합니다. 링크가 미래의 시간에 깨진다면 - 이런 일이 일어난다.
-
는 AS3 : 한 줄 의견을
//
:이 사용하는 동안
/**
*
* to comment (if necessary) a method or a group of related methods
*
*/
: AS3에서
/**
* This is a usual doc comment for a type or property.
*/
/*
* This is a marker of a particular longer section of code.
*/
// This is a single line comment before a or at end of a line of code.
나는 더 높은 레벨 (추상 클래스 등)에 동의하는 경향이 있지만, 낮은 레벨에서는 필자가 자주 바꿀 것으로 예상되는 것들을 설명하기위한 코멘트를 쓰고있다. 나는 내 코드가 "완벽하게 읽을 수있는"것으로 생각하지 않는다고 생각한다. 나는 또한 계약자의 두려움은 gunna rock up이고 wtf와 같다고 가정한다. 이렇게 빠른 수정 또는 기발한 부호, 나는 def. 그것을 주석으로 달아 라. – danjah
"장래에 코드를 유지 관리하는 사람은 항상 당신이 살고있는 곳을 아는 사이코 패스라고 가정하십시오." – Landric
@Jens : 코드는 자명하지만 매우 큰 코드 코드 조각? –
, 나는 이것을 사용합니다.
더욱이 코드 재 작성 가능성을 얻으려면 보통 공백 인 //을 삽입해야합니다.
필요에 따라 주석 달기와 내 경우에는 doc processing-jsdoc 모두 여기와 같습니다. – danjah