问

VC++注释,文档和IntelliSense

後誨A沩鉨乄菰単发布于 2023-02-12 12:00

sum

在C#中,我评论这样的方法:

    /// 
    /// Does absolutely nothing
    /// 
    /// First useless parameter
    /// Second useless parameter
    /// zero
    public int Foo(int a, int b)
    {
        return 0;
    }

这提供了非常好的IntelliSense提示窗口:

在此输入图像描述

什么,如果有的话,在Visual C++或(甚至更好)的解决方案中是等效的,可以在其他IDE如XCode或Eclipse中使用？

更新

我发现了类似的问题,但是@ edtheprogrammerguy的答案有很好的参考,所以我将把questino放在这里.此外,SO不会让我删除我的问题.

更新第二个

许多C#XML注释(

例如)开箱即用.这会是很好,如果///注释自动插入必需的summary,param并且returns标签,但我想,这将会是很容易用新的代码片段来实现.

更新第三个

这是一个插入标题的代码片段.它不扫描方法参数列表,但它是一个很好的开始.保存Documents\Visual Studio 2012\Code Snippets\Visual C++\My Code Snippets为带.snippet扩展名的任何内容,重新启动VS,然后summ在方法上方键入+ TAB 激活.



  
    
      
        Expansion
      
      SnippetFile1
      dlively
      Insert a summary/param/return header for a method
      
      
      summ
    
    
      
        
          summary_text
          summary_text
          Insert description of method
          
          
        
        
          returns_text
          returns_text
          Description of return value
          
          
        
        
          parameter_name
          parameter_name
          Name of the parameter
          
          
        
        
          parameter_description
          parameter_description
          Description
          
          
        
      
      
/// $summary_text$
///


/// $parameter_description$
/// $returns_text$]]>

此外,请参阅非常好的Code Snippet Designer VS扩展,这使得创建这些变得轻而易举.

撰写答案

今天，你开发时遇到什么问题呢？

立即提问

热门标签