태터데스크 관리자

도움말
닫기
적용하기   첫페이지 만들기

태터데스크 메시지

저장하였습니다.

달력

10

« 2017/10 »

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  •  
  •  
  •  
  •  

SHFB(Sandcastle Help File Builder)를 이용하여 .NET 프로젝트 문서화를 할 때(코드주석 문서화하자 참조) namespace에 해당하는 페이지에서는 항상 문서화 주석이 없다는 붉은 오류 메시지가 포함되어 상당히 보기 안좋았는데, 오늘 잠깐 검색을 해서 방법을 찾았습니다. 이것은 SHFB에 포함된 도움말의 색인에서 NamespaceDoc class 항목을 찾아보면 볼 수 있는 내용입니다.

해당 네임스페이스에 NamespaceDoc 이라는 클래스를 만들고 그 클래스에 문서화 주석을 달면 SHFB가 빌드할 때 네임스페이스 도움말로 바꿔줍니다. 아래와 같은 코드를 만드는거죠.

namespace TheNamespace
{
    /// <summary>
    /// 이 네임스페이스로 말할 것 같으면, 아무튼 멋지구리하다는 것!
    /// </summary>
    [System.Runtime.CompilerServices.CompilerGenerated]
    class NamespaceDoc
    {
    }
}

이렇게 써주면 TheNamespace 에 해당하는 도움말 페이지에는 NamespaceDoc 클래스의 문서화 주석 내용이 표시되는 겁니다. 이제 더이상 별로 보기 안 좋은 붉은 글씨를 안 봐도 되겠네요!



신고
Posted by wafe

댓글을 달아 주세요

지난 스프린트부터 XML 문서화 주석을 충실히 작성하여 활용하기로 결정했다. 그러기 위해서 주석도 코드 리뷰 대상으로 포함시켜서 품질을 유지하기로 했다.

그리하여 Visual Studio의 XML 문서화 주석을 이용해서 MSDN 스타일의 도움말 파일을 만들어 내는 방법을 경민 씨가 자이닉스 개발부 블로그에 잘 정리해주었다.

신고
Posted by wafe

댓글을 달아 주세요

2009.11.15 13:50

시각화, 문서화 분류없음2009.11.15 13:50

cavin이라는 아이디를 사용하시는 분의 블로그 포스트에서 구글 독스 소개 동영상을 보았다.

위 동영상을 보면 UI 프로토타이핑에서 사용하는 페이퍼 프로토타이핑 기법을 이용했다고 볼 수 있는데, 메일의 단점과 그에 비한 구글 독스의 장점을 간단한 그림과 설명을 통해 잘 표현하고 있다.

이 동영상을 보니 문득 영회님의 블로그에서 본 산출물을 영리하게 만들지 못할 뿐, 애꿎은 산출물 탓은 하지 말자라는 포스트가 떠올랐다.

어떻게 하면 의도를 잘 전달할 수 있는가? 꼭 문서의 형태로 정리해야 하는가? 하는 의문에 대한 답이 될 수 있는 영상과 블로그 포스트라고 생각한다.

문서화 작업이라는 것이 귀찮고 하기 싫은 일임은 분명하다. 내게 있어서는 스스로 잘 할 수 있다는 충분한 자신감이 없다는 것도 하기 싫은 이유 중에 한 몫을 차지한다.

일반적으로 뭔가를 잘 하기 위해서는 두 가지가 필요하다고 생각한다.
  • 좋은 예제를 많이 보아야 한다. 처음부터 무에서 유를 창조하기는 매우 어렵다.
  • 직접 많이 해보아야 한다. 해보지 않으면 내 몸에 남지 않고 다음 단계의 고민으로 나아가기 힘들다.
구글 동영상과 블로그 포스트를 통해서 좋은 예제를 접할 수 있었다. 다음 과제는 명확한데..., 일단 블로그에 글을 남기는 것으로 일단락 짓는다.
신고
Posted by wafe

댓글을 달아 주세요



티스토리 툴바