2012-08-06 3 views
4

Visual Studio에서 이와 같은 주석을 생성 할 수있는 도구가 있습니까? 특히 아래에 표시된 주석과 같은 다이어그램을 생성 할 수있는 기능.비주얼 스튜디오 코멘트 생성 도구

// 
// +---------------+ 
// |    | 
// | start_connect |<---+ 
// |    | | 
// +---------------+ | 
//   |   | 
// async_- | +----------------+ 
// connect() | |    | 
//   +--->| handle_connect | 
//    |    | 
//    +----------------+ 
//       : 
// Once a connection is  : 
// made, the connect  : 
// actor forks in two -  : 
//       : 
// an actor for reading  :  and an actor for 
// inbound messages:  :  sending heartbeats: 
//       : 
// +------------+   :   +-------------+ 
// |   |<- - - - -+- - - - ->|    | 
// | start_read |      | start_write |<---+ 
// |   |<---+    |    | | 
// +------------+ |    +-------------+ | async_wait() 
//   |   |      |   | 
// async_- | +-------------+  async_- | +--------------+ 
// read_- | |    |  write() | |    | 
// until() +--->| handle_read |    +--->| handle_write | 
//    |    |     |    | 
//    +-------------+     +--------------+ 
// 

답변

4

난 당신 비주얼 스튜디오에 통합 아무것도 찾을 수 있습니다 의심하지 않지만, 당신이 AsciiFlow에 관심이있을 수 있습니다, 온라인 ASCII 흐름 차트 생성기 (귀하의 의견에 당신이 할 수있는 복사 - 붙여 넣기).

그렇다면 기본적으로 건축 문서가 있습니다. 이러한 종류의 광범위 획정 문서는 (거의) 결코 의견의 일부가되어서는 안됩니다. 의견은 간결하고 간결해야하며 (특히 팀에서 일하는 경우) 요점을 설명해야합니다. 더 많은 정보를 얻으려면 많은 리소스 중 하나를 읽으십시오. 여기에있는 인기있는 리소스 중 하나는 Google C++ Style Guide입니다.

흐름도 등은 전체적으로 사람이 읽을 수 있고 소스 파일에 깊숙이 묻혀 있지 않은 보조 문서 (디자인 문서 또는 API 문서)의 일부로 훨씬 더 적합합니다.

+1

나는 Google C++ 스타일 가이드를 최악의 열혈에 권장하지 않습니다. 거기에 더 나쁜 것은 없지만 권장 사항의 일부는 Google에 매우 한정적이므로 (예외는 피하여 생성자에서 작업하지 않아야합니다 ...) 초보자는 무엇을 보관하고 무엇을 던지는지 이해하기가 매우 어렵습니다. out ... –

+1

나는 주석 섹션 (그러므로 #comments 앵커)을 위해 스타일 가이드를 추천하고 있었다. 나는 당신이 사용하는 프로그래밍 언어가 무엇이든간에 좋은 리소스라고 생각한다. 나는 다른 부분이 너무 구체적일지도 모른다는데 동의한다. –