blocks|key|193789|text|将其设置为“三个单注释标记”|type|unstyled|depth|inlineStyleRanges|entityRanges|data|193790|在C#中是///|offset|length|style|CODE|193791|默认情况下会输出：|193792|///+<summary>
///+
///+</summary>
///+<returns></returns>|code-block|syntax|javascript|193793|这是some+tips+on+editing+VS+templates.|193794|entityMap|0|LINK|mutability|MUTABLE|url|https://dbouwman.wordpress.com/2007/06/12/streamline-coding-with-visual-studio-templates/^0|0|5|3|0|0|0|2|Y|0|0^^$0|@$1|2|3|4|5|6|7|Y|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|Z|8|@$D|10|E|11|F|G]]|9|@]|A|$]]|$1|H|3|I|5|6|7|12|8|@]|9|@]|A|$]]|$1|J|3|K|5|L|7|13|8|@]|9|@]|A|$M|N]]|$1|O|3|P|5|6|7|14|8|@]|9|@$D|15|E|16|1|17]]|A|$]]|$1|Q|3|-4|5|6|7|18|8|@]|9|@]|A|$]]]|R|$S|$5|T|U|V|A|$W|X]]]]

Make that "three single comment-markers"

In C# it's <code>///</code>

which as default spits out:

<pre class="lang-cs prettyprint-override"><code>/// &lt;summary&gt;
/// 
/// &lt;/summary&gt;
/// &lt;returns&gt;&lt;/returns&gt;
</code></pre>

Here's <a href="https://dbouwman.wordpress.com/2007/06/12/streamline-coding-with-visual-studio-templates/" rel="noreferrer">some tips on editing VS templates.</a>

blocks|key|959996|text|///|type|code-block|depth|inlineStyleRanges|entityRanges|data|syntax|javascript|959997|是获取方法描述注释块的快捷方式。但在添加函数之前，请确保您已经写好了函数名称和签名。首先写出函数名和签名。|unstyled|959998|然后只需在函数名上方键入/|959999|你会自动得到它|960000|​|960001|📷|atomic|offset|length|960002|entityMap|0|IMAGE|mutability|IMMUTABLE|imageUrl|https://ask.qcloudimg.com/http-save/yehe-900000/68e16ebb700df21b0789a16547566f7d.gif|imageAlt^0|0|0|0|0|0|0|1|0|0^^$0|@$1|2|3|4|5|6|7|10|8|@]|9|@]|A|$B|C]]|$1|D|3|E|5|F|7|11|8|@]|9|@]|A|$]]|$1|G|3|H|5|F|7|12|8|@]|9|@]|A|$]]|$1|I|3|J|5|F|7|13|8|@]|9|@]|A|$]]|$1|K|3|L|5|F|7|14|8|@]|9|@]|A|$]]|$1|M|3|N|5|O|7|15|8|@]|9|@$P|16|Q|17|1|18]]|A|$]]|$1|R|3|-4|5|F|7|19|8|@]|9|@]|A|$]]]|S|$T|$5|U|V|W|A|$X|Y|Z|-4]]]]

<pre><code>///
</code></pre>

is the shortcut for getting the Method Description comment block.
But make sure you have written the function name and signature before adding it.
First write the Function name and signature.

Then above the function name just type ///

and you will get it automatically

<a href="https://i.stack.imgur.com/xtpSX.gif"><img src="https://i.stack.imgur.com/xtpSX.gif" alt="enter image description here"></a>

blocks|key|193881|text|Visual+Assist也有一个nice+solution，并且具有很高的可移植性。|type|unstyled|depth|inlineStyleRanges|entityRanges|offset|length|data|193882|在调整它以生成doxygen风格的注释后，这两次单击将生成-|193883|/**
*+Method:++++FindTheFoo
*+FullName:++FindTheFoo
*+Access:++++private+
*+Qualifier:
*+@param++++int+numberOfFoos
*+@return+++bool
*/
private+bool+FindTheFoo(int+numberOfFoos)
{

}|code-block|syntax|javascript|193884|(在默认设置下，它有点不同。)|193885|193886|编辑:自定义“文档方法”文本的方法是在VassistX->Visual+Assist选项->建议下，选择“编辑VA代码片段”，语言:+C%2B%2B，类型:重构，然后转到“文档方法”并进行自定义。上面的示例是通过以下方式生成的：|193887|​|193888|📷|atomic|193889|193890|entityMap|0|LINK|mutability|MUTABLE|url|http://www.wholetomato.com/products/features/documentMethod.asp|1|IMAGE|IMMUTABLE|imageUrl|https://ask.qcloudimg.com/http-save/yehe-900000/a27b76b2d4c6199f76fda6f64d32470a.png|imageAlt^0|H|D|0|0|0|0|0|0|0|0|0|1|1|0|0^^$0|@$1|2|3|4|5|6|7|19|8|@]|9|@$A|1A|B|1B|1|1C]]|C|$]]|$1|D|3|E|5|6|7|1D|8|@]|9|@]|C|$]]|$1|F|3|G|5|H|7|1E|8|@]|9|@]|C|$I|J]]|$1|K|3|L|5|6|7|1F|8|@]|9|@]|C|$]]|$1|M|3|-4|5|6|7|1G|8|@]|9|@]|C|$]]|$1|N|3|O|5|6|7|1H|8|@]|9|@]|C|$]]|$1|P|3|Q|5|6|7|1I|8|@]|9|@]|C|$]]|$1|R|3|S|5|T|7|1J|8|@]|9|@$A|1K|B|1L|1|1M]]|C|$]]|$1|U|3|Q|5|6|7|1N|8|@]|9|@]|C|$]]|$1|V|3|-4|5|6|7|1O|8|@]|9|@]|C|$]]]|W|$X|$5|Y|Z|10|C|$11|12]]|13|$5|14|Z|15|C|$16|17|18|-4]]]]

Visual Assist has a <a href="http://www.wholetomato.com/products/features/documentMethod.asp" rel="noreferrer">nice solution</a> too, and is highly costumizable. 

After tweaking it to generate doxygen-style comments, these two clicks would produce -

<pre><code>/**
* Method: FindTheFoo
* FullName: FindTheFoo
* Access: private 
* Qualifier:
* @param int numberOfFoos
* @return bool
*/
private bool FindTheFoo(int numberOfFoos)
{

}
</code></pre>

(Under default settings, its a bit different.)

<hr>

Edit: 
The way to customize the 'document method' text is under VassistX->Visual Assist Options->Suggestions, select 'Edit VA Snippets', Language: C++, Type: Refactoring, then go to 'Document Method' and customize. The above example is generated by:

<a href="https://i.stack.imgur.com/6hO1r.png" rel="noreferrer"><img src="https://i.stack.imgur.com/6hO1r.png" alt="va_doxy"></a>

blocks|key|4257420|text|通常，如果您在您想要注释的对象(方法、类)上添加三个单独的注释标记，Visual+Studio会自动创建它。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|4257421|在C#中，这应该是///.|offset|length|style|BOLD|CODE|4257422|如果Visual+Studio不执行此操作，您可以在|4257423|4257424|选项->文本编辑器->C#->高级|blockquote|4257425|4257426|4257427|和复选|4257428|4257429|为/生成XML文档注释|4257430|4257431|4257432|​|4257433|📷|atomic|4257434|4257435|entityMap|0|IMAGE|mutability|IMMUTABLE|imageUrl|https://ask.qcloudimg.com/http-save/yehe-900000/b0ee175c295f5ddb74439bd060fb2868.png|imageAlt^0|0|9|3|9|3|0|0|0|0|0|0|0|0|0|0|0|0|0|1|0|0|0^^$0|@$1|2|3|4|5|6|7|1C|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|1D|8|@$D|1E|E|1F|F|G]|$D|1G|E|1H|F|H]]|9|@]|A|$]]|$1|I|3|J|5|6|7|1I|8|@]|9|@]|A|$]]|$1|K|3|-4|5|6|7|1J|8|@]|9|@]|A|$]]|$1|L|3|M|5|N|7|1K|8|@]|9|@]|A|$]]|$1|O|3|-4|5|6|7|1L|8|@]|9|@]|A|$]]|$1|P|3|-4|5|6|7|1M|8|@]|9|@]|A|$]]|$1|Q|3|R|5|6|7|1N|8|@]|9|@]|A|$]]|$1|S|3|-4|5|6|7|1O|8|@]|9|@]|A|$]]|$1|T|3|U|5|N|7|1P|8|@]|9|@]|A|$]]|$1|V|3|-4|5|6|7|1Q|8|@]|9|@]|A|$]]|$1|W|3|-4|5|6|7|1R|8|@]|9|@]|A|$]]|$1|X|3|Y|5|6|7|1S|8|@]|9|@]|A|$]]|$1|Z|3|10|5|11|7|1T|8|@]|9|@$D|1U|E|1V|1|1W]]|A|$]]|$1|12|3|Y|5|6|7|1X|8|@]|9|@]|A|$]]|$1|13|3|-4|5|6|7|1Y|8|@]|9|@]|A|$]]]|14|$15|$5|16|17|18|A|$19|1A|1B|-4]]]]

Normally, Visual Studio creates it automatically if you add three single comment-markers above the thing you like to comment (method, class).

In C# this would be <code>///</code>.

If Visual Studio doesn't do this, you can enable it in 

<blockquote>
 Options->Text Editor->C#->Advanced
</blockquote>

and check 

<blockquote>
 Generate XML documentation comments for ///
</blockquote>

<a href="https://i.stack.imgur.com/QrxUC.png" rel="noreferrer"><img src="https://i.stack.imgur.com/QrxUC.png" alt="pictured description"></a>

blocks|key|4257393|text|在visual+basic中，如果你首先创建你的函数/sub，然后在它上面的一行上，你输入‘三次，它将自动生成文档的相关xml。当您将鼠标悬停在intellisense中时，以及当您使用该函数时，也会显示此消息。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|4257394|entityMap^0|0^^$0|@$1|2|3|4|5|6|7|D|8|@]|9|@]|A|$]]|$1|B|3|-4|5|6|7|E|8|@]|9|@]|A|$]]]|C|$]]

In visual basic, if you create your function/sub first, then on the line above it, you type ' three times, it will auto-generate the relevant xml for documentation. This also shows up when you mouseover in intellisense, and when you are making use of the function.

blocks|key|193773|text|您可以使用代码段插入所需的任何行。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|193774|此外，如果您在函数标题上方的行上键入三个单引号(‘)，它将插入XML标题模板，然后您可以填写该模板。|193775|这些XML注释可以由文档软件解释，它们作为assembly.xml文件包含在构建输出中。如果将XML文件与DLL一起保留，并在另一个项目中引用该DLL，则这些注释将在intellisense中可用。|193776|entityMap^0|0|0|0^^$0|@$1|2|3|4|5|6|7|H|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|I|8|@]|9|@]|A|$]]|$1|D|3|E|5|6|7|J|8|@]|9|@]|A|$]]|$1|F|3|-4|5|6|7|K|8|@]|9|@]|A|$]]]|G|$]]

You can use code snippets to insert any lines you want.

Also, if you type three single quotation marks (''') on the line above the function header, it will insert the XML header template that you can then fill out. 

These XML comments can be interpreted by documentation software, and they are included in the build output as an assembly.xml file. If you keep that XML file with the DLL and reference that DLL in another project, those comments become available in intellisense.

blocks|key|4257356|text|我正在开发一个名为Todoc的开源项目，该项目在保存文件时自动分析单词以生成正确的文档输出。它尊重现有的注释，并且非常快速和流畅。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|4257357|http://todoc.codeplex.com/|offset|length|4257358|entityMap|0|LINK|mutability|MUTABLE|url^0|0|0|Q|0|0^^$0|@$1|2|3|4|5|6|7|M|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|N|8|@]|9|@$D|O|E|P|1|Q]]|A|$]]|$1|F|3|-4|5|6|7|R|8|@]|9|@]|A|$]]]|G|$H|$5|I|J|K|A|$L|C]]]]

I'm working on an open-source project called Todoc which analyzes words to produce proper documentation output automatically when saving a file. It respects existing comments and is really fast and fluid.

<a href="http://todoc.codeplex.com/" rel="nofollow">http://todoc.codeplex.com/</a>

I was wondering if there is a way (hopefully keyboard shortcut) to create auto generate function headers in visual studio.

Example:

<pre><code>Private Function Foo(ByVal param1 As String, ByVal param2 As Integer)
</code></pre>

And it would automagically become something like this...

 

<pre><code>'---------------------------------- 
'Pre: 
'Post:
'Author: 
'Date: 
'Param1 (String): 
'Param2 (Integer): 
'Summary: 
Private Function Foo(ByVal param1 As String, ByVal param2 As Integer)
</code></pre>

Auto generate function documentation in Visual Studio

翻译质量差，导致语言生硬或混乱。

没有提供实际的解决方法或示例。

解答不清晰，无法理解或解决问题。

页面排版不美观，阅读体验差。

文章

问答

视频

学习中心

腾讯云实验室

直播

竞赛

腾讯云代码分析专区

腾讯iOA零信任安全管理系统专区

腾讯云架构师技术同盟交流圈

腾讯云数据库专区

腾讯云顾问专区

腾讯云原生专区

腾讯混元专区

腾讯云TCE专区

腾讯云Lighthouse专区

腾讯云HAI专区

腾讯云Edgeone专区

腾讯云存储专区

腾讯云智能专区

腾讯轻联专区 

腾讯云开发专区

TAPD专区

腾讯轻量云游戏服专区

腾讯云最具价值专家

腾讯云架构师技术同盟

腾讯云创作之星

腾讯云开发者先锋

腾讯云代码助手

云原生构建

TAPD 敏捷项目管理

Cloud Studio

SDK中心

API中心

命令行工具

涵盖代码开发、场景应用、自动测试全流程，助你从零构建专属AI助手

一站式MCP教程库，解锁AI应用新玩法

我想知道是否有一种方法(最好是键盘快捷键)可以在visual studio中创建自动生成函数头。示例：Private Function Foo(ByVal param1 As String, ByVal param2 As Integer)它会自动变成像这样的东西。'---------------------------------- 'Pre: 'Post:'Author: 'Date: 'Pa

问在Visual Studio中自动生成函数文档
EN

回答 7

Stack Overflow用户

Stack Overflow用户

Stack Overflow用户

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问在Visual Studio中自动生成函数文档EN

回答 7

Stack Overflow用户

Stack Overflow用户

Stack Overflow用户

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问在Visual Studio中自动生成函数文档
EN