C# WINFORMS 주석의 중요성

주석을 잘적어놓는 소스는 여러사람에게 정말 도움이 많이 된다.

주석을 작성하는것을 습관하는것이 좋다.

이렇게 사용할 목적을 넣어서 이거를 나중에 보면 내가 볼수도 다른사람이 볼수도 있기 때문이다.

두번쨰 목적은 

 private void Form1_Load(object sender, EventArgs e)
        {
            lboxDay.Items.Add(enumDay.Monday);  //월요일 입니다.
            lboxDay.Items.Add(enumDay.Tuesday);
            //lboxDay.Items.Add(enumDay.Wednesday); // 수요일은 바빠서 만날수 없어서 임시 제거
            lboxDay.Items.Add(enumDay.Thursday);
            lboxDay.Items.Add(enumDay.Friday);
            lboxDay.Items.Add(enumDay.Saturday);
            lboxDay.Items.Add(enumDay.Sunday);

            //ListBox에 사용할 시간을 넣습니다.
            lboxTime.Items.Add(enumTime.Morning);
            lboxTime.Items.Add(enumTime.Afternoon);
            lboxTime.Items.Add(enumTime.Evening);
        }

다시 수요일이 필요하면 주석을 보고 주석을 제거하면 된다.

이런식으로 소스를 테스트할때나 막아놓고 쓸때 주석을 많이 사용한다.

 

그리고 통으로 쓰이지 않을때도 쓴다.

메소드에대해 설명이 필요할때도 주석을 쓴다!

 

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Windows.Forms;

namespace study_Enum
{
    public partial class Form1 : Form
    {
        public Form1()
        {
            InitializeComponent();
        }

        enum enumDay
        {
            Monday,    
            Tuesday,  
            Wednesday, 
            Thursday, 
            Friday,   
            Saturday,
            Sunday,
        }
        enum enumTime
        {
            Morning,
            Afternoon,
            Evening,
        }

        private void Form1_Load(object sender, EventArgs e)
        {
            lboxDay.Items.Add(enumDay.Monday);  //월요일 입니다.
            lboxDay.Items.Add(enumDay.Tuesday);
            //lboxDay.Items.Add(enumDay.Wednesday); // 수요일은 바빠서 만날수 없어서 임시 제거
            lboxDay.Items.Add(enumDay.Thursday);
            lboxDay.Items.Add(enumDay.Friday);
            lboxDay.Items.Add(enumDay.Saturday);
            lboxDay.Items.Add(enumDay.Sunday);

            //ListBox에 사용할 시간을 넣습니다.
            lboxTime.Items.Add(enumTime.Morning);
            lboxTime.Items.Add(enumTime.Afternoon);
            lboxTime.Items.Add(enumTime.Evening);
        }

        private void btnResult_Click(object sender, EventArgs e)
        {
            //준호와 Monday(요일) Afternoon에 보기로 했습니다.

            string strResult = tboxName.Text + "와" + lboxDay.SelectedItem.ToString() + "(요일)" +
                lboxTime.SelectedItem.ToString() + "에 보기로 했습니다.";
            tboxResult.Text = strResult;
        }

        private void btnResult2_Click(object sender, EventArgs e)
        {
            string strResult = TextLoad(tboxName.Text, lboxDay.SelectedItem.ToString(), lboxTime.SelectedItem.ToString());//String.Format("{0}와 {1}(요일) {2}에 보기로 했습니다.", tboxName.Text, lboxDay.SelectedItem.ToString(), lboxTime.SelectedItem.ToString());

            tboxResult.Text = strResult;
        }

        /// <summary>
        /// 준호와 Monday(요일) Afternoon에 보기로 했습니다. 같은 문자열을 만들어 줍니다.
        /// </summary>
        /// <param name="strName">이름</param>
        /// <param name="strday">날짜</param>
        /// <param name="strTime">시간</param>
        /// <returns></returns>
        private string TextLoad(string strName, string strday, string strTime)
        {

            string strText = String.Format("{0}와 {1}(요일) {2}에 보기로 했습니다.", strName, strday, strTime);

            return strText;
        }
    }
}

이렇게 메서드에대한 설명을 메서드 위에 마우스를 올려 놓으면 볼수가 있게 된다.