C#中的三種註釋與其快捷鍵、以及創建類時自動生成類的註釋的設置方法

一、C#中的註釋:

1.註釋

註釋符的作用:1)註銷代碼;2)註釋內容

2.C#中的三種註釋方法:

1)單行註釋://
快捷鍵:
添加註釋:ctrl+k,ctrl+c
撤銷註釋:ctrl+k,ctrl+u
2)多行註釋://
3)文檔註釋:/// 多用來解釋類和方法
快捷方式:直接在類或者方法上敲三個斜槓,就會自動補全該註釋的格式。
		/// <summary>
        /// 這個類用來驗證卡號是否存在
        /// </summary>
	public class CheckCardID
	{
	}
  		/// <summary>
        /// 這個方法是:驗證文本框內容是否爲空
        /// </summary>
        /// <param name="values">要驗證的文本</param>
        public  void Check(params object[] values)
        {
            foreach (object text in values)  //遍歷values的值,判斷是否爲空
            {
                if (text.ToString() == "")  //如果文本爲空
                {
                    throw new Exception("請將信息填寫完整");  //拋出提示信息
                }
            }
        }

二、今天小編要講的重點是:自定義自動生成類註釋的模板設置(每次新建一個類都會自動顯示一個類的註釋說明)

比如:模板時這樣的:
在這裏插入圖片描述

要實現每次新建一個類都會自動生成一個類的註釋說明,需要設置一個模板,自定義自動生成的模塊註釋:

1. 首先我們要找到C# 的安裝路徑:

默認路徑爲:

C:\ProgramFiles(x86)\MicrosoftVisualStudio14.0\Common7\IDE\ItemTemplates\CSharp\Code\2052\Class

以上路徑中Microsoft Visual Studio 14.0爲小編電腦中安裝的版本,讀者可根據自己的下載版本進行選擇。

如果你安裝的路徑不是默認的,並且不確定安裝到哪裏了,可以按照小編的另一篇博客,查看自己電腦上該軟件的安裝位置:

按照以上路徑查找,最終呈現的窗體爲:

在這裏插入圖片描述

用記事本打開Class.cs文件:

同樣,其他的:比如創建一個接口,想要實現自動生成接口註釋,方法一樣,找到Interface.cs文件,用記事本打開:

在這裏插入圖片描述

這樣就實現了新創建一個類或者接口時,自動生成模塊註釋。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章