C# 小技巧 參數內容提示

平時使用 IDE 在寫程式時,通常都會有自動提示,猜測你接下來要輸入的程式碼。而在輸入「字串」的內容時不會有提示,因為字串裡面可以輸入的內容太多了,他沒有很好的依據可以猜出來你要輸入的內容是什麼。

例如下面程式碼中第六行的兩個引號中間,在這裡輸入內容通常無法獲得提示
    
void Paint(string str)
{
    Console.WriteLine(str);
}

Paint("");
    


不過有個小技巧可以很好的幫助我們,就是使用註解告訴 IDE 我們等等會輸入的內容是什麼格式

    
void Paint(string str)
{
    Console.WriteLine(str);
}

Paint( /*lang=regex*/ "");

使用註解後,在字串內輸入到一半時 Visual Studio 就會提示我們可以輸入的內容

在 Rider 中也會給我們提示

目前筆者測試下來有效的是以下三種:
  • /*lang=regex*/
  • /*lang=xml*/
  • /*lang=html*/
並且 lang 可以替換為 language

對輸入內容可以起到提示的作用

在 Rider 中,格式錯誤時也會有醒目的標記,不過因為只是註解,在不符合註解中標記的語言規則時,雖然會提示錯誤,不過不像程式語法錯誤一樣,依然可以編譯執行。

快寫完的時候筆者又發現 regex 和 html 只要在變數前面加上註解就可以

而 xml 在變數前面加並沒有作用,一定要是傳入的參數前面才有效

留言