코드 주석 달기 - 사용 된 디자인 패턴이 주석 처리되어야 함

클래스에서 디자인 패턴이 사용 된 경우 클래스 상단 또는 관련 메서드의 맨 위에있는 주석은 사용 된 특정 디자인 패턴이나 실제 기능을 설명해야합니다 .코드 주석 달기 - 사용 된 디자인 패턴이 주석 처리되어야 함

즉

/** 
* Class MyClass 
* 
* Utilizes Factory Method patter to accomplish xyz 
*/

또는

/** 
* Class MyClass 
* 
* Allows the creation of objects for xyz 
*/

이

은 매우 내 쿼리의 주요 부분은 사용 된 어떤 디자인 패턴 궁금 다른 사람에 의존 여부

을 설명하기 위해 단순화 또는 어떤 디자인 패턴을 사용했는지 말하면서 똑똑한 엉덩이처럼 보일 수도 있습니다.

출처

2012-08-26 Marty Wallace

내 이름은 좋은 이름 지정과 캡슐화가 끝나면 좋은 설명이 시작된다는 것입니다. 어쨌든, 코멘트가 유지되는 한 어떤 패턴이 사용되고 있는지를 알리는 데 어떤 가능한 해가 있습니까? – derpface

일반적인 연습은 클래스 (예 : XyzFactory)의 이름을 지정하여 사용하는 패턴을 쉽게보고 주석의 실제 기능을 제공 할 수 있습니다. 디자인 패턴이 이미 수행 한 것만 설명하는 것이 더 바람직합니다.

출처

2012-08-26 17:19:26 Clarence

당신은 이것에 대한 몇 가지 upvotes가 있지만, 이것은 좋은 연습 코드베이스 접미사 즉, XyzFactory XyzSingleton XyzTemplate 사용하여 코드베이스 주위에있을 것이라고 생각하지 않았을거야 - 그래서 나는 보드에 그것을 취할 것입니다. 이것은 많은 프레임 워크에서 공통적입니까? –

예 Symfony2 및 Zend Framework 2와 같은 현대 프레임 워크에서 일반적으로 사용되는 방법입니다. 오래된 프레임 워크 또는 단순한 최악의 프레임 워크는이를 많이 사용하지 않을 수도 있습니다. – Clarence

외부 의존성이 있다면 그것을 언급하는 것이 좋습니다. 다른 함수 (PHP의 mt_rand 대 rand 참조)와 대조되는 경우 언급하는 것도 좋습니다.

그렇지 않으면 말할 필요도 없지만 개인적인 취향에 따라 달라질 수 있습니다.

출처

2012-08-26 17:19:44

코드 주석 달기 - 사용 된 디자인 패턴이 주석 처리되어야 함

답변

관련 문제