精华内容
下载资源
问答
  • 关于 shell 中的单行注释和多行注释的问题,本文档介绍两种实用的方法。文内含长段代码可复制可往左滑,希望对大家有帮助!一. 单行注释:众所周知 # , 比如想要注释 echo "Hello World"[root@Jaking~]#vimtest.sh#...

    93292680867cac0d2cdb508dccbd89a7.png

    b1e6f633e1e7225a6eb1b84d297639af.png

    关于 shell 中的单行注释和多行注释的问题,本文档介绍两种实用的方法。文内含长段代码可复制可往左滑,希望对大家有帮助!

    一. 单行注释:

    众所周知 # , 比如想要注释 echo "Hello World"

    [root@Jaking ~]# vim test.sh
    # echo "Hello World
    "

    二. 多行注释:

    方法一
    : <
    语句1
    语句2
    语句3
    语句4
    !

    举例

    [root@Jaking ~]# bash test.sh
    Hello World
    Hello World
    Hello World
    Hello World
    Hello World
    Hello World
    [root@Jaking ~]# cat test.sh
    #!/bin/ksh
    echo "Hello World"
    echo "Hello World"
    echo "Hello World"
    echo "Hello World"
    echo "Hello World"
    echo "Hello World"
    :<echo "Hello World"
    echo "Hello World"
    echo "Hello World"
    echo "Hello World"
    echo "Hello World"
    echo "Hello World"
    echo "Hello World"
    echo "Hello World"
    !

    方法二

    '
    语句1
    语句2
    语句3
    语句4
    '

    举例

    [root@Jaking ~]# bash test.sh
    Hello World
    Hello World
    Hello World
    Hello World
    Hello World
    Hello World
    [root@Jaking ~]# cat test.sh
    #!/bin/ksh
    echo "Hello World"
    echo "Hello World"
    echo "Hello World"
    echo "Hello World"
    echo "Hello World"
    echo "Hello World"
    '
    echo "Hello World"
    echo "Hello World"
    echo "Hello World"
    echo "Hello World"
    echo "Hello World"
    echo "Hello World"
    echo "Hello World"
    echo "Hello World"
    '

    总   结

    本文到此结束,以上就是关于 shell 注释的方法介绍,选择其中一种来用即可。希望对你有帮助!

    2838bac7d61a002929552789c8ddb0d8.png

    如果喜欢这位作者的文章,点点在看支持一下~

    9cfd7529d43a9de5c5a7d75ad8b191d9.png

    END

    4c95c9a68b671e87cb233719e289518b.png

    官方站点:www.linuxprobe.com

     Linux命令大全:www.linuxcool.com

    Linux系统下载站:www.linuxdown.com

    d269399f46ca17b38c8aafaeaeb8adf4.png

    刘遄老师QQ:5604922

    Linux技术交流群:193666693

    (新群,火热加群中……)

    书籍在线学习(电脑阅读效果佳)

    http://www.linuxprobe.com/chapter-00.html

        想要学习Linux系统的读者可以点击按钮来了解书籍《Linux就该这么学》,同时也非常适合专业的运维人员阅读,成为辅助您工作的高价值工具书!

    展开全文
  • 简述该参考是基于Doxygen注释规范进行简单归纳,可以适当根据自己的需求进行约定。Doxygen可以从一套归档源文件开始,生成HTML格式的... 简单注释(1) 单行注释///(2) 多行注释/**2. 文件注释/***@file文件名*@brief...

    简述

    该参考是基于Doxygen注释规范进行简单归纳,可以适当根据自己的需求进行约定。

    Doxygen可以从一套归档源文件开始,生成HTML格式的在线类浏览器,或离线的LATEX、RTF参考手册。简单来说就是一个程序的文件产生工具,可将程序中的特定注释转换成为说明文件。

    6dbef9291d04af83535b3a5686a4dd6f.png

    注释规范内容

    1. 简单注释

    (1) 单行注释

    ///

    (2) 多行注释

    /**

    2. 文件注释

    /***@file     文件名*@brief    简介*@datails  细节*@mainpage 工程概览*@autor    作者*@email    邮箱*@version  版本号*@date     年-月-日*@license  版权*/

    3. 常量/变量注释

    (1)代码前注释

    ///注释

    变量/常量定义

    (2)代码后注释

    变量/常量定义 ///

    4. 函数注释

    下面是函数的详细注释,可根据实际情况增减相关条目。

    /***@brief     函数简介*@datail    详细说明**@param     形参 参数说明*@param     形参 参数说明*@return    返回说明*@retval    返回值说明*@note      注解*@attention 注意*@warning   警告*@exception异常*/

    5. 其他内容注释

    命令 生成字段名 说明

    @see 参考

    @class 应用类 用于文档生成连接

    @var 引用变量 用于文档生成连接

    @enum 引用枚举 用于文档生成连接

    @code 代码块开始 与@endcode成对使用

    @endcode 代码块接收 与@code成对使用

    @bug 缺陷

    @todo

    @example 使用例子说明

    @remarks 备注说明

    @pre 函数前置条件

    @deprecated 函数过时说明

    展开全文
  • 前言 使用过Java的同学都非常熟悉,Java中有:单行注释 // 这是单注释多行注释 /*这是多行注释*/ Javadoc注释 /**这是javadoc注释*/ 其实这里面还有很多细节呢,下面我们一一来揭晓哪些地方需要添加注释 首先,我们...

    前言

    使用过Java的同学都非常熟悉,Java中有:

    • 单行注释 // 这是单注释
    • 多行注释 /*这是多行注释*/
    • Javadoc注释 /**这是javadoc注释*/

    其实这里面还有很多细节呢,下面我们一一来揭晓

    哪些地方需要添加注释

    首先,我们需要确定一下,添加注释的目的是什么?(手动思考10秒)。

    我认为添加注释,是为了程序更容易理解与维护,特别是维护,更是对自己代码负责的一种体现。

    那基于这样的目的,在日常开发中,我们需要在哪些地方添加注释呢?

    • 类,接口。

    这一部分注释是必须的。在这里,我们需要使用javadoc注释,需要标明,创建者,创建时间,版本,以及该类的作用。如下所示:

    package com.andyqian.utils;/** * @author: andy * @date: 18-01-05 * @version: 1.0.0 * @description: 生成PDF 工具类 */public class PdfUtil {}
    • 方法

    在方法中,我们需要对入参,出参,以及返回值,均要标明。如下所示:

     /** * 生成pdf文件 * @param htmlContent 待生成pdf的 html内容 * @param file 生成pdf文件地址 * @see PdfUtils#getFontPath() * @return true 生成成功 false 生成失败 */ public static boolean generatePdf(String htmlContent,File file){ ... return result; }
    • 常量

    对常量,我们需要使用多行注释,进行标明该常量的用途,如下所示:

    /** * @author: andy * @date: 18-01-05 * @version: 0.0.1 * @description: */public class StatusConsts { /** * 博客地址 */ public static final String BLOG="www.andyqian.com";}
    • 关键算法上

    在关键算法上,添加注释并且按照顺序依次标明,写明白该方法为什么这么做。如下所示:

    /** * 应用场景: * 1.在windows下,使用Thread.currentThread()获取路径时,出现空对象,导致不能使用 * 2.在linux下,使用PdfUtils.class获取路径为null, * 获取字体路径 * @return 返回字体路径 */ private static String getFontPath(){ String path=""; // 1. ClassLoader classLoader= Thread.currentThread().getContextClassLoader(); URL url = (classLoader==null)?null:classLoader.getResource("/"); String threadCurrentPath = (url==null)?"":url.getPath(); // 2. 如果线程获取为null,则使用当前PdfUtils.class加载路径 if(threadCurrentPath==null||"".equals(threadCurrentPath)){ path = PdfUtils.class.getClass().getResource("/").getPath(); } // 3.拼接字体路径 StringBuffer stringBuffer = new StringBuffer(path); stringBuffer.append("/fonts/SIMKAI.TTF"); path = stringBuffer.toString(); return path; }

    怎么添加注释?

    1. IDEA 自动生成

    对于类中的注释,我们可以通过IDEA自动生成。

    如IDEA 可以通过:File->Settings->Editor->File and Code Templates->Includes->File Header来设置模板,这样新建文件时,IDEA会按照设置的模板,会自动生成一个注释,就不需要一个一个敲了。

    ded2735976befbe650ac292398a4f0bb.png

    其中标签有:

    ${USER} : 当前用户。

    ${DATE} : 当前日期。

    ${PACKAGE_NAME}:包名。

    ${TIME}: 当前时间。

    ${YEAR}: 当前年。

    ${MONTH}:当前月。

    ${DAY}: 当前日。

    ${HOURS}: 当前小时。

    ${MINUTE}: 当前分钟

    1. 注释引用

    如果方法中引用了其他的方法,在注释中如何体现呢?细心的朋友,应该已经发现了,在上面的:

     /** * 生成pdf文件 * @param htmlContent 待生成pdf的 html内容 * @param file 生成pdf文件地址 * @see PdfUtils#getFontPath() * @return true 生成成功 false 生成失败 */ public static boolean generatePdf(String htmlContent,File file){ ... return result; }

    中的@see就有这个作用,其语法是:

    @see package.class#method label@see #field@see #method(Type, Type,...)@see #method(Type argname, Type argname,...)@see #constructor(Type, Type,...)@see #constructor(Type argname, Type argname,...)

    例如:

     @see PdfUtils#getFontPath()

    如果是同一个类中,package(包名全路径)可以省略。有相同功能的标签有:

    {@link package.class#metod}

     /** * 生成pdf文件 * @return true 生成成功 false 生成失败 * @throws Exception * {@link PdfUtils#getFontPath()} */ public static boolean generatePdf(String htmlContent,File file){ .... }

    其区别是:@see必须要在注释行首,{@link}可以在任意位置。

    1. 在IDEA中,我们可以选中方法通过快捷键Ctrl+D即可查看我们添加的注释,如下图所示:
    76605bb017ac91e616d096b14a7f2b34.png
    1. 如果需要引用外网的连接,我们可以通过HTML标签中的a标签来表示,如下所示:
    @see 博客地址

    以下为javadoc 需要熟知的注释标签:

    @see 引用类/方法。

    @author: 作者。

    @date:日期。

    @version: 版本号。

    @throws:异常信息。

    @param:参数

    @return: 方法返回值。

    @since: 开源项目常用此标签用于创建日期 。

    {@value}: 会使用该值,常用于常量。

    {@link} 引用类/方法。

    {@linkplain} 与@link功能一致。

    完整案例如下:

    package com.andyqian.pdf.utils;import com.itextpdf.text.log.Logger;import com.itextpdf.text.log.LoggerFactory;import java.io.File;import java.net.URL;/** * @author: 鞠骞 * @date: 18-01-05 * @version: 1.0.0 * @description: 生成PDF 工具类 */public class PdfUtils { private static final Logger logger = LoggerFactory.getLogger(PdfUtils.class); /** * 生成pdf文件 * @param htmlContent 待生成pdf的 html内容 * @param file 生成pdf文件地址 * @see https://itextpdf.com/ * @return true 生成成功 false 生成失败 */ public static boolean generatePdf(String htmlContent,File file)throws Exception{ ... return true; } /** * 应用场景: * 1.在windows下,使用Thread.currentThread()获取路径时,出现空对象,导致不能使用 * 2.在linux下,使用PdfUtils.class获取路径为null, * 获取字体路径 * @return 返回字体路径 */ private static String getFontPath(){ String path=""; // 1. ClassLoader classLoader= Thread.currentThread().getContextClassLoader(); URL url = (classLoader==null)?null:classLoader.getResource("/"); String threadCurrentPath = (url==null)?"":url.getPath(); // 2. 如果线程获取为null,则使用当前PdfUtils.class加载路径 if(threadCurrentPath==null||"".equals(threadCurrentPath)){ path = PdfUtils.class.getClass().getResource("/").getPath(); } // 3.拼接字体路径 StringBuffer stringBuffer = new StringBuffer(path); stringBuffer.append("/fonts/SIMKAI.TTF"); path = stringBuffer.toString(); return path; }}

    添加注释时的一点建议

    1. 类中,接口等必须有创建时间,创建人,版本号,描述等注释。
    2. 注释不是越多越好,比如:get/set方法就不需要写注释。更不需要每一行都写注释。
    3. 注释需要写的简明易懂。特别是方法的参数,以及返回值。
    4. 每一次修改时,相应的注释也应进行同步更新。
    5. 在类,接口,方法中,应该都使用/** */javadoc注释。因为这样调用者就不需要进入方法内部才知道方法的用处。提高编码效率。
    6. 方法代码中如果有顺序之分,最好将代码也加上序号,如1,2,3等。
    7. 枚举中的每一个值都需要添加注释。

    小结

    写注释是一个好习惯,能让自己和团队都受益,如果你接手一个一丁点注释都没有的项目,那么上一个程序员就倒霉了(此处省略N个字),不知你们有没有看过开源项目的源码,那注释写的相当详细,大家可以多多参考,争取别做一个”倒霉”的程序员。

    8e6b471d68f17547171f351a5f031398.png
    展开全文
  • 第二种,多行注释 /*…注释的内容…*/;第三种 文档注释 /**..注释的内容….*/。不难发现,第三种注释方式和第二种方式很相似,那它出现的目的是什么呢?就是为了便于javadoc程序自动生成文档。接下来咱们聊一聊这个...

    a47e5c100783863544427f0c467e8f51.png

    我们知道在java中注释有三种。

    第一种,单行注释 //注释的内容;

    第二种,多行注释 /*…注释的内容…*/;

    第三种 文档注释 /**..注释的内容….*/。

    不难发现,第三种注释方式和第二种方式很相似,那它出现的目的是什么呢?就是为了便于javadoc程序自动生成文档。接下来咱们聊一聊这个文档注释⋯⋯

    添加注释的原则

    代码注释是架起程序设计者与程序阅读者之间的通信桥梁,最大限度的提高团队开发合作效率,也是程序代码可维护性的重要环节之一。

    所以看起来非常简单的注释也是有些原则需要遵守:

    1、注释形式统一

    在整个应用程序中,使用具有一致的标点和结构的样式来构造注释。如果在其它项目中发现它们的注释规范与这份文档不同,按照这份规范写代码,不要试图在既成的规范系统中引入新的规范。

    2、注释内容准确简洁

    内容要简单、明了、含义准确,防止注释的多义性,错误的注释不但无益反而有害。

    注释可以添加的位置

    作为注释,语法上当然是可以添加在程序的任意位置啦!但是我们在添加时候还是要添加在合适的位置,一般添加在类和方法上。如下图所示:

    18a2088842899edd5918304071cf54cd.png

    大家仔细看,可以发现注释中有这些东西@author,@version,@see,@param ⋯⋯,这些都是什么含义呢?

    这些都称之为java doc标记,含义如下:

    @author 标明开发该类模块的作者

    @version 标明该类模块的版本

    @see 参考转向,也就是相关主题

    @param 对方法中某参数的说明

    @return 对方法返回值的说明

    @exception 对方法可能抛出的异常进行说明

    其中,@author 可以多次使用,以指明多个作者,生成的文档中每个作者之间使用逗号 (,) 隔开。

    @version 也可以使用多次,只有第一次有效。

    @param、@return 和 @exception 这三个标记都是只用于方法的。

    把注释生成文档的方式

    通常在编写程序时我们会用IDE工具,比如eclipse,咱们来看看怎么用eclipse生成文档。如下图:

    第一步:

    cde086183f2dd4f355b02f3fbdb51543.png


    下一步:

    350f2e2e5cfe189027bd6d2e890288fb.png

    下一步:

    4a40b5859df647cfae977b6f361305ee.png

    接着点finish就好啦,可能在点finish的时候弹出一个框,直接选择”yes to all”就好了!找到我的E:myapi文件夹,会发现生成了很多文件:

    e1d1b304266367f77564d0a22d46dea3.png

    用浏览器打开你就看到自己想要的东西了!

    说完这个,咱们再说说如何用doc生成文档:

    看图:

    d1a7aa3e414d3bb43723b9488476bb1d.png

    参数说明

    -public 仅为public访问级别的类及类的成员生成javaDoc文档

    -proteceted 仅为public和protected访问级别的类及类的成员生成javadoc文档.

    (默认选项)

    -d 指定API文档的输出目录,默认是当前目录。建议总是指定该参数。

    然后找到E:mydosapi文件夹,打开index.html就看到文档已经生成好了⋯⋯

    好了,java文档注释就说到这里,如果还有不明白的,那就自行体会,哈哈⋯⋯

    展开全文
  • 因为IE各版本的浏览器对我们制作的 WEB标准的页面解释不一样具体就是对 CSS 的解释不同我们为了兼容这些可运用条件注释来各自定义最终达到兼容的目的 块注 释的使用感兴趣的朋友可以参考下 html中的普通注释 &t!...
  • html多行注释方法

    2015-11-10 11:42:00
    Html单行:&lt;!-- --&gt;多行:&lt;!-- --&gt;javascript单行://多行:/* */Vbscript单行:'多行:'ASP &lt;% %&gt;中: 单行:' 多行:'
  • 一、初始 HTML1. 基本介绍超文本标记语言(英语:Hyper Text Markup Language,简称:HTML)是一种用于创建网页的标准标记语言。HTML常与CSS、JavaScript 一起被众多网站用于设计令人赏心悦目的网页、网页应用程序...
  • html——注释(单行注释 多行注释

    万次阅读 多人点赞 2018-07-26 21:22:49
     这是多行注释  这是多行注释  这是多行注释 --&gt; JS/jQuery注释: //这是单行注释 /*  这是多行注释  这是多行注释  这是多行注释 */ css注释: /*这是单行注释*/ /*  这是多行注释  这是多行...
  • HTML文件多行注释

    2020-07-31 23:18:45
    CTRL + Q 进行多行注释
  • css多行注释的方法:首先创建一个css示例文件;然后通过“/* 文本 */”语法进行多行注释即可,注释代码如“/* This is an example of a CSS multi-line comment */”。本教程操作环境:windows7系统、css3版,DELL ...
  • HTML注释: ... 多行注释 多行注释 多行注释 --> css注释: /*单行注释*/ /* 多行注释 多行注释 多行注释 */ JS注释: //单行注释 /* 多行注释 多行注释 多行注释 */ ...
  • 主要通过两种方式来使用javADOc:嵌入的html,或使用“文档标记”。其中,“文档标记”(Doc tags)是一些以“@”开头的命令,置于注释行的起始处(但前导的“*”会被忽略)。有三种类型的注释文档,它们对应于位于注释...
  • 多行注释: 1. 进入命令行模式,按ctrl + v进入 visual block模式,然后按j, 或者k选中多行,把需要注释的行标记起来 2. 按大写字母I,再插入注释符,例如// 3. 按esc键就会全部注释了 取消多行注释: 1. ...
  • VI 的多行注释

    2018-12-21 17:31:31
    多行注释: 进入命令行模式,按ctrl + v进入 visual block模式,然后按j, 或者k选中多行,把需要注释的行标记起来 按大写字母I,再插入注释符,例如// 按esc键就会全部注释了 取消多行注释: 进入命令行...
  • 注释: 先CTRL+K,然后CTRL+C取消注释: 先CTRL+K,然后CTRL+U 转载于:https://www.cnblogs.com/MagicAsa/p/9243557.html
  • 原文:https://www.cnblogs.com/Ph-one/p/5641872.html多行注释:1. 进入命令行模式,按ctrl + v进入 visual block模式,然后按j, 或者k选中多行,把需要注释的行标记起来2. 按大写字母I,再插入注释符,例如//3. 按...
  • vim多行注释

    2017-04-18 10:01:11
    vim中多行注释和多行删除命令,这些命令也是经常用到的一些小技巧,可以大大提高工作效率。 多行注释:首先按esc进入命令行模式下,按下Ctrl + v,进入列(也叫区块)模式; 在行首使用上下键选择需要注释的多行; 按...
  • 多行注释: CTRL+K,CTRL+C取消多行注释: CTRL+K,CTRL+U 转载于:https://www.cnblogs.com/zksh2016/p/6713578.html
  • HTML多行注释

    2016-08-14 11:59:00
    注释的符号是 开头:&...其实HTML注释格式单行和多行都是一样的,你多行的时候就是把结尾的-->打到最后就是了 例如: <!-- 这是注释 内容 --> 转载于:https://www.cnblogs.com/223y/p/5769900.html...
  • 多行注释:/*多行注释信息*/。 示例1 把位于//字符后一行内的所有字符视为单行注释信息。下面几条注释语句可以位于代码段的不同位置,分别描述不同区域代码的功能。 //程序描述 function toStr(a){ //块描述 //...
  • python多行注释

    2019-09-29 12:53:04
    单行的注释:# 多行注释:三个单引号和三个双引号都可以 1 ''' 2 代码 3 ''' 4 5 """ 6 代码 7 """ 转载于:https://www.cnblogs.com/chamie/p/4857135.html
  • HTML注释: 1 2 3 4 5 6 <!--这是单行注释--> <!-- 这是多行注释 这是多行注释 这是多行注释 --> JS/jQuery注释: ...这是多行注释...
  • 多行注释呢?其实ASP里不支持多行注释,比如/**/等肯定无法实现。也有一种间接的方法,那就是将ASP代码作为HTML代码一样的注释,很明显这是很没安全的做法,因为会直接暴露源代码。 借助Dreamweaver8,可以方便地...
  • Spyder多行注释快捷键

    千次阅读 2019-02-19 11:09:54
    Ctrl+1:多行注释/多行反注释 Ctrl+4/5: 块注释/块反注释 Tab:代码缩进 Tab+Shift:代码反缩进 参考博文:https://www.cnblogs.com/beforeluck-shang/p/8370849.html
  • 一、JSP注释格式来源JSP是Sun Microsystems公司制定的一种服务器端动态网页技术的组件规范,其主体由HTML、CSS、...二、JSP注释格式内容1、前端相关1)HTLM格式注释:(多行注释)2)CSS格式注释:/* 注释内容 */(多行...
  • 一、JSP1、显式注释,格式: 2、隐式注释,格式:3、脚本程序注释//单行注释/**多行注释内容1*多行注释内容2*/%>二、ASP在每行后面要注释的地方,打上英文单引号(’)三、ASP.NET1、标准的HTML注释,会包含在最终...

空空如也

空空如也

1 2 3 4 5 ... 20
收藏数 1,480
精华内容 592
关键字:

html多行注释