none
如何自定义方法上的文档注释 RRS feed

  • 问题

  • 如题,现在想要重写在方法上自动生成的文档注释,希望能够自动加上作者和创建时间,不知道怎么样进行修改,自己尝试着使用代码端来做<summary>部分,但是不知道怎么获取当前日期,求助
    2016年10月10日 4:19

答案

  • 您好,感谢您的回复,您说的这个解决方案没解决我的问题,stackoverflow上的文章中提到的 Alt + F8 没反应也没找到 宏管理 ,但是给了我解决问题的思路。

    我的解决方案是这样的:

    首先设置自己的代码段:

    snippet

    在扩展与更新中下载了一个管理宏的插件 Macros for Visual Studio.

    Macros for Visual Studio

    这个插件中的插入当前日期不太符合我的习惯,宏代码是javascript代码,代码比较简单,于是根据需要自己进行了修改,并设置了快捷键

    Macros0

    Macro1

    • 已编辑 WeihanLee 2016年10月11日 8:52 补充
    • 已标记为答案 WeihanLee 2016年10月11日 8:52
    2016年10月11日 8:42

全部回复

  • 作者和日期应该自己手动加上。类似:

    /***************************************************************************************
     * *
     * *        File Name        : HotelCommentHeaderInfo.cs
     * *        Creator            : ziqiu.zhang
     * *        Create Time        : 2008-09-17
     * *        Functional Description  : 酒店的点评头模型。包括酒店实体对应的点评头,酒店的OutHotelInfo信息
     *                                    ,酒店实体的Tag信息集合。
     * *        Remark      : 
     * *
     * *  Copyright (c) eLong Corporation.  All rights reserved. 
     * ***************************************************************************************/

    具体参考:http://www.cnblogs.com/mq0036/p/3544264.html

    制作在线帮助文档:

     1、下载Sandcastle Help File Builder:

    https://github.com/EWSoftware/SHFB/releases

    2、下载sandcastle:

    http://sandcastle.codeplex.com/releases/view/47665

    1、先安装sandcastle,然后安装sandcastle Help File Builder。接着在使用sandcastle Help File Builder时配置好sandcastle安装路径(选项卡中的Path里的sandcastle Path)。

    2、在VS环境中选择项目,右击鼠标选属性,切换到Build选项卡,然后把XML File Documentation打钩即可,生成项目。

    3、最后在sandcastle Help File Builder菜单:Project-->New Project from Visual Studio..即可导入工程。


    ASP.NET Forum
    StackOverFlow
    FreeRice Donate
    Issues to report



    2016年10月10日 5:01
    版主
  • 您好,作者我可以写死,但是日期我希望能够自动生成不需要自己手动改,暂时不需要生成文档,不考虑做帮助文档
    2016年10月10日 6:20
  • 你好,

    根据我的测试,时间是没有办法自动生成,通过snippet code. 你可以设置宏来快捷使用。

    http://jingyan.baidu.com/article/ea24bc39b86ededa62b3311f.html

    根据这个文档我测试了,没什么问题,只有时间没有办法自动添加。

    如果想自动添加时间,请参考这个文档:

    http://stackoverflow.com/questions/1029189/insert-current-datetime-in-visual-studio-snippet

    Best Regards,

    Hart


    We are trying to better understand customer views on social support experience, so your participation in this interview project would be greatly appreciated if you have time. Thanks for helping make community forums a great place. Click HERE to participate the survey.

    2016年10月11日 5:29
    版主
  • 您好,感谢您的回复,您说的这个解决方案没解决我的问题,stackoverflow上的文章中提到的 Alt + F8 没反应也没找到 宏管理 ,但是给了我解决问题的思路。

    我的解决方案是这样的:

    首先设置自己的代码段:

    snippet

    在扩展与更新中下载了一个管理宏的插件 Macros for Visual Studio.

    Macros for Visual Studio

    这个插件中的插入当前日期不太符合我的习惯,宏代码是javascript代码,代码比较简单,于是根据需要自己进行了修改,并设置了快捷键

    Macros0

    Macro1

    • 已编辑 WeihanLee 2016年10月11日 8:52 补充
    • 已标记为答案 WeihanLee 2016年10月11日 8:52
    2016年10月11日 8:42