VS2008 활용

1. 주석 잘 달기

   

<summary> : 개체에 대한 요약

    '/' 슬래시 키를 3번 눌러서 서머리태그를 생성한다.

   

<param> / <return> : 파라메타와 리턴 값의 요약

    인텔리전스에 보일 주석의 내용을 작성한다.

   

<see> / <seealso> : 구성요소에 참조 요약

    실제 문서화할때, 유용하게 쓰임

    문서화 할때, 링크를 제공하기 위해 사용됨 (MSDN의 도움말과 같은 기능)

     

    예) ///<summary>

         ///<see cref="ConsolApp1.program" />    : 참조할 개체기술

         ///</summary>

         ///<seealso cref="program.strat" />     : 추가적으로 참조할 개체기술

   

<exception>  : 예외정보 요약

        예)

        ///<summary>

        ///Test 메서드입니다.

        ///<param name="a">인자값입니다</param>

        ///</summary>

        ///<exception chef="System.NullReferenceException">파라메타값이 null이면 발생합니다.</exception>

   

<remarks> : 개체의 추가정보

        예)

        ///<summary>

        ///Test 메서드입니다.

        ///<param name="a">인자값입니다</param>

        ///</summary>

      ///<remarks>

      ///2008.09.01 변경이력을 기술한다.

      ///2008.09.02 홍길동이 수정했음

      ///</remarks>

   

//TO DO : 한줄주석

        // TO DO : 주석내용

        VS2008의 [보기] - [작업목록]을 보게되면 각각의 TO DO 에 대한 작업목록을 한눈에 확인할 수 있다

         

#region ~ #endregion : 코드를 그룹화한다.

        각 메서드의 시작과 끝 지점에 #region과 #endregion을 넣어줌으로써 해당 메서드들의 구역을 설정하여 그룹화한다.

   

<code></code> : 실제 코드의 사용방법을 기술한다.

        문서화할때의 예제코드로 사용됨

   

   

이처럼  XML 주석을 사용하라면, 해당 프로젝트 속성에서 XML문서파일 부분에 체크박스를 체크해주어야 한다.

BIN폴더에  XML 파일로 해당 주석의 내용들이 저장되어진다.

   

이러한 주석내용을 토대로 CHM파일을 생성하려면

이전 포스트의 내용에 있는 샌드캐슬이라는 프로그램을 이용하여, 문서화한다.

   

2. 편리한 툴 기능

   

2-1. 사용자 작업목록

   

    [보기]의 [작업목록]을 눌러보면, 처음에는 TO DO 의 내용이 보여질 리스트가 나타난다.

    윗쪽의 선택상자를 이용하여 [사용자 작업]을 선택한다.

    개발자가 작업해야 할 내용들을 하나씩 기술한뒤,

    해당 작업들이 마무리 되는 순으로, [작업목록]의 내용들에 체크를 해준다.

   

    해당 작업좌측에서 더블클릭시 작업의 우선순위를 지정해 줄 수 있음

    우선순위별로 정렬가능.

   

2-2. 문서개요

   

    WebForm / WinForm / WPF 모두 가능함

    [보기] - [다른창] - [문서개요]

   

    트리형태로 문서내의 각 컨트롤에 대한 구조가 표시됨

   

2-3. 책갈피 (Ctrl + B.T)

   

    각 소스파일에서 단축키 (Ctrl + B.T)를 사용하여 책갈피를 지정해놓고

    책갈피 탭을 열어서 해당 소스와 파일들을 책갈피 기능을 이용하여 쉽게 이동할 수 있다.

   

2-4. 도구상자

   

    다수의 소스를 저장해 둘 수 있도록 클립보드와 같은 기능을 한다.

    해당 소스를 드로그앤드롭으로 쉽게 사용 가능한다.

   

    도킹해서 사용해야 한다는 점이 가장 불편한 점이다.

    이는 도구상자 기능과는 별개인  Comment Helper를 사용하면 조금 더 쉽게 이용 가능하다.

   

3. 강력한 디버깅

   

3-1. 디버깅

   

기본적인 디버깅 - F5 - 솔루션 전체 빌드됨

새 인스턴스 시작 - 하나의 프로젝트만 디버깅 (참조 포함 빌드)

   

    소스에서 브레이크 포인트(빨강포인트)를 걸고 [솔루션 탐색기]의 해당 프로젝트명에서

    마우스 우버튼 - [디버그] - [새 인스턴스 시작]

     

   새 인스턴스 시작으로 하는것이 속도가 빠름

   

디버깅 시, 순차적으로 디버깅 하는 방법

    [F10] : 다음 소스코드로 이동(메서드만 실행하고 다음 코드로 넘어감)

    [F11] : 해당 메서드의 내부 코드까지 들어갈 수 있음

   

3-2. 추적점 삽입하기

   

    소스에서 마우스 우버튼 클릭후 [중단점] - [추적점 삽입]

    좌측에 마름모꼴의 빨간 추적점이 생김

   

    이는 종단점과는 다르게

    해당 소스가 멈춰지지 않고, 어떠한 값을 계속해서 추적해 나갈 수 있는 기능이다.

   

   

4. 깔끔한 코드작성하기

   

4-1. #region을 이용하여 그룹화 하되, 각 #region마다의 계층구조를 둠으로써 시각적으로 보기좋게 한다.

   

    예)

   

    #region Tmp

              :

        #region Tmp1

                 :

        #endregion

              :

    #endregion

   

4-2. 연속된 대입코드를 탭키를 이용하여 정렬한다. 

   

        (자동서식 설정 해제 하는 방법 : [도구] - [옵션] - [텍스트편집기] - [서식] - [일반] - [자동지정] 부분 체크 해제)

    예)

   

    string a        = "xxxxx";

    int num        = 12;

    bool bl         = false;

   

4-3. 주석을 꾸미지 마라.

   

    얘)

   

    //****************************************//

    //**** 1. 각 메서드의 값 반환 **************//

    //****************************************//

   

위와 같은 주석보다는 // TO DO 형식의 주석이 VS관리체계에도 적합

   

   

참고자료 : 데브피아 MicroSoft ASP.NET MVP 엄준일 동영상자료

블로그 : http://blog.powerumc.kr

   

<http://minimango.tistory.com/191>에서 삽입