精华内容
下载资源
问答
  • idea去除文档注释中某个标签的警告

    千次阅读 2019-02-18 09:45:13
    【说明】举个例子,我要在文档注释中写“@hahaha”(当然实际开发中不会这么写,哈哈哈),写完后idea会把这个注释标签搞个背景颜色(如下图),作为一个有强迫症的人来说,这看起来相当不爽,于是就踏上了去除这个...

    【说明】举个例子,我要在文档注释中写“@hahaha”(当然实际开发中不会这么写,哈哈哈),写完后idea会把这个注释标签搞个背景颜色(如下图),作为一个有强迫症的人来说,这看起来相当不爽,于是就踏上了去除这个背景颜色的征途。

    把鼠标放在这个注释标签上,会有错误提示

    【步骤】

    1、点击该参数,让光标停留在这个参数上,会出现一个小灯泡

    2、点击小灯泡,选择它的提示项:Add hahaha to custom tags

    【效果】

    展开全文
  • 使用正则表达式去除文档注释

    千次阅读 2008-03-07 14:11:00
    可匹配单行、多行注释,可正确识别正则表达式中的//或/*字符var str="....";str.replace(/////[^/n]*|///*([^/*^//]*|[/*^//*]*|[^/**//]*)*/*///g,)
    可匹配单行、多行注释,可正确识别正则表达式中的'//'或'/*'字符
    var str="....";
    str.replace(/[^/n]*|///*([^/*^//]*|[/*^//*]*|[^/**//]*)*/*///g,'')
    展开全文
  • 文档注释

    2017-12-08 17:54:19
    1.properties文件註釋是:# 注意:不能用中文註釋 .../* ....*/ 內容註釋 快捷鍵:ctrl + shift + / 去除 ctrl + shift + \ // 快捷鍵:ctrl +/ 去除 ctrl +/ 3.xml和html 文件的註釋:>>> 快捷鍵: ctrl + shift
      1.properties文件註釋是:# 注意:不能用中文註釋

    2.java 文件註釋是:/**.......*/文檔註釋 :方法..類..屬性
    /* ....*/ 內容註釋 快捷鍵:ctrl + shift + / 去除 ctrl + shift + \
    // 快捷鍵:ctrl +/ 去除 ctrl +/

    3.xml和html 文件的註釋:<!--...-->>>> 快捷鍵: ctrl + shift +/ 去除 : ctrl + shift + \

    4.js文件註釋: //

    5.JSP文件註釋:<%--註釋內容--%>或 <!--註釋內容--!>
    快捷鍵:ctrl + shift +/

    6.oracle註釋:-- 或者/* */
    展开全文
  • 文档注释的配置与各个IDE生成文档 前言 编程这么多年(也就两年吧),没有深刻认识到文档注释的牛逼,今天来学习一下 IDEA与Java文档 文档注释 我们以IDEA编写java程序来示范,主要参考文章是这里: ...

    文档注释的配置与各个IDE生成文档

    前言

    编程这么多年(也就两年吧),没有深刻认识到文档注释的牛逼,今天来学习一下

     

     

     

     

     


    IDEA与Java文档

    文档注释

    我们以IDEA编写java程序来示范,主要参考文章是这里

    类注释模板

    在IDEA的Setting=》File and Code Template中的File=》Class设置类注释,例如我的内容如下:

    /**
     * @ClassName ${NAME}
     * @Description TODO
     * @Author ${USER}
     * @Date ${DATE} ${TIME}
     * @Version 1.0
     */

    Class文件

    (1)${NAME}:设置类名,与下面的${NAME}一样才能获取到创建的类名

    (2)TODO:代办事项的标记,一般生成类或方法都需要添加描述

    (3)${USER}、${DATE}、${TIME}:设置创建类的用户、创建的日期和时间,这些事IDEA内置的方法,还有一些其他的方法在绿色框标注的位置,比如你想添加项目名则可以使用${PROJECT_NAME}

    (4)1.0:设置版本号,一般新创建的类都是1.0版本,这里写死就可以了

     

    方法注释模板

    IDEA还没有智能到自动为我们创建方法注释,这就是要我们手动为方法添加注释,使用Eclipse时我们生成注释的习惯是

    /**+Enter,这里我们也按照这种习惯来设置IDEA的方法注释。

    打开:File–>Settings–>Editor–>Live Templates。

    新建一个组,叫做userDefine

    新建模板:命名为*

    因为IDEA生成注释的默认方式是:/*+模板名+快捷键(比如若设置模板名为add快捷键用Tab,则生成方式为

    /*add+Tab),如果不采用这样的生成方式IDEA中没有内容的方法将不可用,例如获取方法参数的methodParameters()、

    获取方法返回值的methodReturnType()

    然后下面的模板文本写上如下内容(要去掉最前面的/*):

    *
     * @Author $user$
     * @Description //TODO 
     * @Date $time$ $date$
     * @Param $param$
     * @return $return$
     **/

    点击模板页面最下方的警告,来设置将模板应用于那些场景,一般选择EveryWhere–>Java即可

    (如果曾经修改过,则显示为change而不是define)

    最后,我们选择右侧的Edit variables按钮,来设置获取参数的方式。

    大功告成,我们可以使用/**+Enter来测试。

     

    生成文档

    IDEA=》工具=》生成JavaDoc

     

     

    这里的生成有一个坑,javadoc命令运行时,默认用了gbk,需要我们在"Tools->Gerenate JavaDoc”面版的Other command line arguments 栏里输入:-encoding utf-8 -charset utf-8

     

     

     


    VS Studio 与 C#文档

    直接在vs中编写C#的时候加入注释文档(通过文档注释“///”),内容:

        class Program
        {
            /// <summary>
            /// 姓名
            /// </summary>
            public string Name { get; set; }
            /// <summary>
            /// 年龄
            /// </summary>
            public int Age { get; set; }
            /// <summary>
            /// 自我介绍
            /// </summary>
            /// <param name="name">姓名</param>
            /// <param name="age">年龄</param>
            /// <returns>自我介绍的内容</returns>
            public string Say(string name, string age)
            {
                return "My name is" + name + ",Age:" + age;
            }
    
            static void Main(string[] args)
            {
                Program p = new Program();
                Console.WriteLine(p.Say("李如一", "34"));
            }
        }

    然后我们点开该项目的属性,然后选择生成,最下面的输出中,勾选生成xml文档文件,然后Ctrl+S保存,然后编译项目即可。

    最后生成的xml文件:

    <?xml version="1.0"?>
    <doc>
        <assembly>
            <name>测试注释文档的项目</name>
        </assembly>
        <members>
            <member name="P:测试注释文档的项目.Program.Name">
                <summary>
                姓名
                </summary>
            </member>
            <member name="P:测试注释文档的项目.Program.Age">
                <summary>
                年龄
                </summary>
            </member>
            <member name="M:测试注释文档的项目.Program.Say(System.String,System.String)">
                <summary>
                自我介绍
                </summary>
                <param name="name">姓名</param>
                <param name="age">年龄</param>
                <returns>自我介绍的内容</returns>
            </member>
        </members>
    </doc>

    关于文档注释中各个键值的意义:

    文档生成器必须接受和处理任何根据 XML 规则有效的标记。下列标记提供了用户文档中常用的功能。(当然,也可能有其他标记。)

    标记 章节 用途
    <c> A.2.1 将文本设置为类似代码的字体
    <code> A.2.2 将一行或多行源代码或程序输出设置为某种字体
    <example> A.2.3 表示所含的是示例
    <exception> A.2.4 标识方法可能引发的异常
    <include> A.2.5 包括来自外部文件的 XML
    <list> A.2.6 创建列表或表
    <para> A.2.7 用于将结构添加到文本中
    <param> A.2.8 描述方法或构造函数的参数
    <paramref> A.2.9 确认某个单词是参数名
    <permission> A.2.10 描述成员的安全性和访问权限
    <summary> A.2.11 描述一种类型
    <returns> A.2.12 描述方法的返回值
    <see> A.2.13 指定链接
    <seealso> A.2.14 生成请参见
    <summary> A.2.15 描述类型的成员
    <value> A.2.16 描述属性

     

     


     

     

     

    商业转载 请联系作者获得授权,非商业转载 请标明出处,谢谢

     

     

     

     

     

    展开全文
  • idea自动为类生成文档注释

    千次阅读 2019-07-09 10:54:42
    文章目录1.为类添加文档注释2.为方法添加文档注释 1.为类添加文档注释 2.为方法添加文档注释
  • JAVA导出文档注释

    2020-07-26 07:52:58
    1.新建类,添加文档注释,注意默认的文档注释有:需要去掉冒号再写 package day0726_1; /** * 该类是求和 * @author Administrator * */ public class GetSum { /** * 求和方法 * @param a parameter ...
  • java 文档注释

    2015-07-28 18:32:00
     但还有第三种,文档注释:  /** ...... */ 注释若干行,并写入 javadoc 文档  通常这种注释的多行写法如下:  /**  * .........  * .........  */  很多人多忽视了这第三种
  • idea多行注释如何取消文档注释 的斜体

    千次阅读 多人点赞 2017-12-22 00:29:51
    idea多行注释如何取消文档注释 的斜体本Markdown编辑器使用[StackEdit][6]修改而来,用它写博客,将会带来全新的体验哦:如下图所示: file->settings->Editor->Color Scheme ->Language Defaults->Comments->Doc ...
  • javadoc和Java文档注释

    2012-09-04 09:12:31
    转载 http://www.blogjava.net/qiyadeng/archive/2006/02/20/31655.html ... 一.... 二. 文档注释的格式  1. 文档注释的格式化  2. 文档注释的三部分   三. 使用 javadoc 标记  1. @see 的使用  2
  • JAVA文档注释1.1

    2016-10-11 17:10:58
    前言  Java 的语法与 C++ 及为... 不完全对,除了以上两种之外,还有第三种,文档注释:  /** ...... */ 注释若干行,并写入 javadoc 文档  通常这种注释的多行写法如下:  /** * ......... * .........
  • 问题描述 ...在pom文件加入以下代码,忽略文档注释 <properties> <maven.test.skip>true</maven.test.skip> <maven.javadoc.skip>true</maven.javadoc.skip> </properti
  • 一、单行注释(也可以多行注释) 1、样式://我是被注释的内容 2、快捷键:ctrl+/ 或 ctrl...三、文档注释 1、样式:/**我是被注释的文档*/ 2、快捷键:Alt+shift+J 3、修改文档注释的文档内容:  打开eclips...
  • idea默认文档注释

    2020-11-29 20:27:27
    文件-设置-File and Code Templates-File Header /** * @BelongsProject: ${PROJECT_NAME} * @BelongsPackage: ${PACKAGE_NAME} * @author: ${USER} * @date: ${DATE} ${TIME} * @Description: ${Description} ...
  • IDEA | 删除文档注释快捷键

    千次阅读 2020-04-23 10:44:52
    为什么会想要这样的快捷键呢,因为文档注释用 ctrl + shift + / 进行消除注释,会出现多余的 ’ * ',如图: 那怎么可以将 ’ * ’ 删除的快点呢,我们回到解除注释之前,用 alt + 鼠标左键下拉,同时对这些多余的 ...
  • Eclipse 的快捷键 文档注释、多行注释的快捷键 一、多行注释快捷键 1.选中你要加注释的区域,用ctrl+shift+C 或者ctrl+/ 会加上//注释 2.先把你要注释的东西选中,用shit+ctrl+/ 会加上/* */注释 3.以上快捷在重复按...
  • Eclipse 的快捷键以及文档注释

    千次阅读 2019-06-04 16:28:31
    1.多行注释快捷键 1.选中你要加注释的区域,用ctrl+...3.以上快捷在重复按一下就会去掉加上的注释 4.要修改在eclispe中的命令的快捷键方式我们只需进入windows -> preference -> General -> key设置就行...
  • Eclipse/MyEclipse的快捷键以及文档注释、多行注释的快捷键 一、多行注释快捷键 1.选中你要加注释的区域,用 Ctrl+Shift+C 或者 Ctrl+/ 会加上 // 注释,再重复按一下就会去掉 // 注释。(.js文件中只有 Ctrl+Shift+...
  • 7.2.2 为函数添加文档注释 注释尽管在程序中不是必须的,但却是必要的。如果没有注释,那么程序就很难被别人读懂,甚至果断时间,自己都看不明白自己写的程序。Python语言支持单行注释和多行注释,前者使用井号(#)...
  • idea取消文档注释中参数编译错误 答 取消参数报错提示,步骤如下: file--》setting--》http://yayihouse.com/yayishuwu/chapter/2077
  • 新电脑需要设置下各种配置其中文档注释很重要的一项 查了好多文档最后自己改了一套 宇宙无敌最终不改版本 首先打开setting 其中模板如下: ** * 描述: $description$ * * @Author ygt 修改这里 * @Date $date$...
  • 【说明】之前开发时,不小添加以下三个自定义标签:“description”、“description:”、“Description”。然后每次输入“@d”的时候就会跳出很多提示,现在我不要它提示带冒号的和首字母大写的(没有那么多为什么,...
  • 关于快捷键 Eclipse 的很多操作都提供了快捷键功能,我们可以通过键盘就能很好的控制 Eclipse 各个功能: 一、多行注释快捷键 ...3.以上快捷在重复按一下就会去掉加上的注释4.要修改在ecli...
  • 一、多行注释快捷键 1.选中你要加注释的区域,用...3.以上快捷在重复按一下就会去掉加上的注释 4.要修改在eclispe中的命令的快捷键方式我们只需进入windows -> preference -> General -> key设置就行了 ...
  • 第一步:启动HelpPageConfig中xml文档 将HelpPageConfig中的Register方法中的第一行代码注释给去掉,如图: ...第三步:取消方法xml文档注释的提示警告 转载于:https://www.cnblogs.co...

空空如也

空空如也

1 2 3 4 5 ... 20
收藏数 92,113
精华内容 36,845
关键字:

如何去掉文档注释