蠍子
如果你正在使用Doxygen或者XML文檔註釋，那麼Visual Studio v16.6 Preview 2了一項稱之為註釋自動生成(automatic comment stub generation)的新特性，這項特性將和現有的快速參考(QuickInfo), 參數幫助(Parameter Help)和成員列表提示(Member List tooltip)等特性一起為開發者提供流暢的編碼體驗。
讓我們來自動生成註釋的基本骨架
在XML文檔註釋中，有一些每次都必須要輸入的關鍵字，例如summary, param等。如果每次編寫註釋的時候都需要手動輸入這些內容，會極大的降低編碼效率，同時導致非常糟糕的編碼體驗。Visual Studio可以通過一種十分自然的方式來自動生成註釋骨架，開發者只需要在註釋骨架上填寫相應的內容即可。
在默認情況下，註釋自動生成只會在XML文檔註釋上起作用。開發者在為一個函數編寫註釋的時候，可以通過輸入三個斜槓(///)或者使用快捷鍵(Ctrl + /)來產生註釋骨架。
有圖有真相
如果我使用Doxygen呢？
如果你不使用XML註釋，而是Doxygen，那麼也不用太擔心，Visual Studio已經為你安排的明明白白了。可以在Visual Studio的設置裡自由切換你喜歡的註釋系統類型，具體的設置路徑：[工具/選項/文本編輯器/C/C++/編碼風格/常規]。當然，你也可以直接通過快捷鍵(Ctrl + Q)來喚醒搜索框，並輸入關鍵字”Doxygen”來快速定位。設置界面如下圖所示：
你可以在上面的設置界面選項觸發自動生成註釋的代碼，比如可以選擇三個斜槓(///)或者/**，這完全跟隨你的喜好來定。當然，快捷鍵(Ctrl + /)也會一直存在，如果你是一個快捷鍵達人，那麼你應該挺喜歡這種方式。
同時，還可以通過修改[.editorconfig]配置文件來在文件夾級別或者文件級別上來指定註釋系統的各項配置參數，下圖是可以添加到[.editorconfig]的配置項：
為了得到一個[.editorconfig]配置文件，你可以在上面的設置界面，點擊按鈕[Generate .editorconfig file from settings]，那麼Visual Studio將會基於現有的配置來生成一個新的配置文件，然後你就可以自由的修改這個配置文件了。這種方式的好處是，你可以為不同的文件夾或者文件設置不一樣的註釋風格，這非常適合於不同開發團隊之間的代碼風格兼容。
自動生成Doxygen註釋
寫註釋的一個好處
有些人可能會問，為什麼要辛辛苦苦的寫那些沒用的註釋呢？請先看看下圖：
有感覺了嗎？你編寫的XML或者Doxygen註釋，Visual Studio已經可以自動識別到了，並且在你調用某個函數的時自動給你信息提示。這項特性，非常適合那些寫完一個函數就忘記怎麼調用的人，比如我。
總結
為代碼編寫註釋，是一個非常好的習慣，我也儘可能會在代碼中寫點註釋，一來可以提醒我代碼的基本意思，二來可以方便我的同事進行閱讀。
就像上面所講述的，如果你使用更加規範化的XML或者Doxygen風格的註釋，那麼生活將會開始展現它美好的一面。
閱讀更多 漫漫開發路 的文章
