Doridori C# 강의) 6.주석

======================================================

안녕하세요 Doridori 입니다. 

이번강의는 주석에 대해서 강의 하도록 하겠습니다. 

지난 강의의 예제를 가지고 진행을 할 예정이라서 UI는 별도로 작성 하지 않았습니다.

======================================================

주석

Soruce 전체) Study_6_Comment.zip

교재) 6강 주석.pdf

코드를 작성 하면서 가장 신경써야 할 부분중의 하나가 바로 주석이지 않을까 하는데요.

코드가 복적해서 내가 작성 했지만 나도 알아보기 어려울 경우, 머리속으로 소스가 정리되지 않을 경우

나 이후에 다른 사람이 인계를 받아서 코드를 이어서 작성 해야 하는경우 

등등 코드의 사용 목적이라던지 코드를 변경 한 내용등을 작성 해 놓았을 경우에 다음에 코드를 분석 할 경우 많은 도움이 됩니다. 

실무에서는 반대 사례로 일부러 코드를 복잡하고 알기 어렵게 짜놓고 주석을 안치는 경우도 있습니다. 

흔히 밥줄 챙기는 기술이다 라고 할수도 있는데요 (심할 경우 변수 명을 a, b, c 따위로 붙이는 경우도 봤습니다.)

대게 프로그램시작 시점에 여러 개발자가 모여서 진행 하게 될 경우 변수 명이라던지 개발 방향이 다르기 때문에 기본적으로 이름들을 정의 하는 부분은 문서로 명시해 놓고 시작하게 되는데 외주로 프로그램을 통으로 요청 할 경우에 무시하고 진행 하는 경우에 발생 합니다. 

개인적으로는 밥줄챙기는것도 나쁘다고는 생각하지 않지만 돈받고 해주는 일이라면 기본적은 퀄은 맞춰 주는것이 맞다고 생각 합니다. 

결론은 주석은 잘 작성 해 줍시다. (나를 위해서도, 나 다음 사람을 위해서도!)

소스 Code 및 내용)

        private void Form1_Load(object sender, EventArgs e)
        {
            lboxAge.Items.Add(enemDay.Monday);  // 주석 1. 코드에 설명을 붙일 때 사용 합니다.
            lboxAge.Items.Add(enemDay.Tuesday);  
            lboxAge.Items.Add(enemDay.Wednesday);
            lboxAge.Items.Add(enemDay.Thuseday);
            //lboxAge.Items.Add(enemDay.Friday);   // 주석 2. 사용하지 않는 줄을 임시로 막아 놓을 경우 사용 합니다. (이전 코드를 남겨 둘 필요가 있을 경우 포함)
            lboxAge.Items.Add(enemDay.Saturday);
            lboxAge.Items.Add(enemDay.Sunday);
 
            // 주석 3. 
            /*lboxName.Items.Add(enumTime.Morning);
            lboxName.Items.Add(enumTime.Afternoon);
            lboxName.Items.Add(enumTime.Evening);*/  //여러 줄을 동시에 막을 경우 사용 합니다.
        }
 
 
        // 주석 4. 
        /// <summary>
        /// 메소드에 대해 설명이 필요 할 경우 사용 합니다. (인자에 대한 설명을 포함 할 경우에도 사용 합니다.  /// 세번으로 자동완성 됩니다.)
        /// </summary>
        /// <param name="strName">이름을 입력 합니다.</param>
        /// <returns>반환 값에 대한 설명을 입력 합니다.</returns>
        private string TextLoad(string strName)
        {
            string strResult = strName + "와" + lboxAge.SelectedItem.ToString() + "(요일), " + lboxName.SelectedItem.ToString() + "에 만납시다.";
 
            return strResult;
        }
 

강의)