編碼時(shí)，在對(duì)高級(jí)語言（C#/VB etc）函數(shù)的訪問時(shí)，經(jīng)常會(huì)有很明確的函數(shù)功能提示，參數(shù)提示，與返回值提示。微軟的VisualStudio C++集成開發(fā)環(huán)境同樣有這樣的功能，只是常見開源的代碼很少按照VS的注釋格式編寫。

VS2015中Ctrl+K，Ctrl+B，或工具菜單選擇“代碼片段管理器”，選擇導(dǎo)入，選擇下面這個(gè)文件，選擇一個(gè)位置，就可以在VS編碼是快速輸入summary（智能提示，輸入su基本就會(huì)出現(xiàn)了），TAB，就會(huì)有格式化的注釋被鍵入，根據(jù)提示輸入注釋的各個(gè)部分。TAB可以在格式中切換位置，ENTER完成輸入。

?

將下面文件保存為summary.snippet,用VS的代碼片段管理器導(dǎo)入即可。

<?xml version="1.0" encoding="utf-8"?> <CodeSnippetsxmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet"><CodeSnippet Format="1.0.0"><Header><Title>注釋</Title><Author>Fyter(fyter.cn)</Author><Description>添加規(guī)范注釋</Description><Shortcut>summary</Shortcut><SnippetTypes><SnippetType>Expansion</SnippetType></SnippetTypes></Header><Snippet><Declarations><Literal><ID>expression</ID><ToolTip>功能描述</ToolTip><Default>函數(shù)</Default></Literal><Literal><ID>pname</ID><ToolTip>功能描述</ToolTip><Default>參數(shù)1</Default></Literal><Literal><ID>pdesc</ID><ToolTip>功能描述</ToolTip><Default>參數(shù)描述</Default></Literal><Literal Editable="true"><ID>returns</ID><ToolTip>參數(shù)描述</ToolTip><Default>成功</Default></Literal><Literal Editable="true"><ID>return_true</ID><ToolTip>返回true</ToolTip><Default>true</Default></Literal><Literal Editable="true"><ID>return_false</ID><ToolTip>返回true</ToolTip><Default>true</Default></Literal></Declarations><Code Language="cpp"><![CDATA[/// <summary> /// $expression$ /// </summary> /// <param name="$pname$">$pdesc$</param> /// <returns> /// $returns$，返回 <c>$return_true$</c>, 否則返回<c>$return_false$</c>. /// </returns>]]></Code></Snippet></CodeSnippet> </CodeSnippets>

?

轉(zhuǎn)載于:https://www.cnblogs.com/fyter/p/vs_cpp_summary_snippet.html

總結(jié)

以上是生活随笔為你收集整理的适用于VS C++环境的注释代码段，可以让你的代码被使用时有高可读性的注释的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。