精华内容
下载资源
问答
  • 代码里写注释怎么写
    千次阅读
    2021-06-13 17:34:23

    html注释:不被程序执行的代码。用于程序员标记代码,在后期的修改,以及他人的学习时有所帮助。对关键代码的注释是一个良好的习惯。在开发网站或者功能模块开发时,代码的注释尤其重要。

    html注释:

    注释标签用来在源文档中插入注释,注释不会在浏览器中显示。

    我们经常要在一些代码旁做一些HTML注释,这样做的好处很多,比如:方便项目组里的其它程序员了解你的代码,而且可以方便以后你对自己代码的理解与修改等等.

    可以在HTML文档中加入自己的注释。注释不会显示在页面中,它可以用来提醒网页设计人员回忆相关的程序信息。注释行的写法如下:

    注:在感叹号后要接两个连字符,大于号前也要有两个连字符。有些浏览器会对此进行严格检查。

    基本语法:

    //和/* */在html里也是常用的注释,但只能用在js和css语言,不对HTML语言起作用!

    豌豆资源搜索网站https://55wd.com 电脑刺绣绣花厂 ttp://www.szhdn.com

    注释的作用

    大家可以看到,用“”注释的内容不会显示在浏览器中。注释标签用于在源代码中插入注释,注释的内容不会显示在浏览器中。对关键代码进行注释,有助于你以后看懂你当时编写的源代码。

    在编写HTML代码时,我们经常要在一些关键代码旁做一下注释,这样做的好处很多,比如:方便理解、方便查找或方便项目组里的其它程序员了解你的代码,而且可以方便以后你对自己代码进行修改。

    对关键代码的注释是一个良好的习惯。在开发网站或者功能模块开发时,代码的注释尤其重要。因为那个时候的代码往往都是几百上千行,你要是不对关键的代码进行注释,往往你自己都会觉得头晕,甚至看不懂自己当时写的代码。

    总结

    以上是编程之家为你收集整理的html注释代码怎么写?全部内容,希望文章能够帮你解决html注释代码怎么写?所遇到的程序开发问题。

    如果觉得编程之家网站内容还不错,欢迎将编程之家网站推荐给程序员好友。

    本图文内容来源于网友网络收集整理提供,作为学习参考使用,版权属于原作者。

    小编个人微信号 jb51ccc

    喜欢与人分享编程技术与工作经验,欢迎加入编程之家官方交流群!

    更多相关内容
  • 一、写代码写注释写代码写注释”自从学编程,这就话就伴随着你。可见注释的重要性。 注释的作用: 说明函数的功能 说明函数参数的意思 说明函数这样设计的原理(计算公式) 说明函数的使用场景 作者和日期 ...

    一、写代码要写注释

    “写代码要写注释”自从学编程,这就话就伴随着你。可见注释的重要性。
    注释的作用:

    • 说明函数的功能
    • 说明函数参数的意思
    • 说明函数这样设计的原理(计算公式)
    • 说明函数的使用场景
    • 作者和日期
    • 说明变量的作用
    • 函数调用方法与注意事项

    总之为了能让读这个函数的人明白这个函数的功能,可以注释各种各样的信息。而没有这些注释文字,就不太容易看懂函数的功能与调用用方法。没有注释的情况下,隔一段时间之后,自己也看懂的自己所写函数的功能了。因此,很多书籍、老师、领导、同事、包括你自己,都会告诉你“一定要写注释,不写是万万不能的”。

    二、注释标准格式

    其实注释没有特别严格的注释格式,但是为了使得注释整齐简洁。还是会有一些格式的要求的。针对不同开发平台,不同编程语言,都有各自不同的注释推荐格式。(高级一些IDE会提供注释快捷键)下面分别列举一些常见的注释格式:

    1. C#
    /// <summary>
    /// 这个方法的作用就是求两个整数之间的最大值
    /// </summary>
    /// <param name="n1">第一个整数</param>
    /// <param name="n2">第二个整数</param>
    /// <returns>返回比较大的那个数字</returns>
    public static int GetMax(int n1, int n2) {}
    
    1. Qt_C++
    /*
     * @Brief:  
     * @Param:  First
     * @Param:  Second
     * @Return: NULL
     */
     void DataManager::SaveValue(int First, int Second) {}
    
    1. Java
    /**
    * This method inputs a number from the user.
    * @return The value output as a double.
    * @exception IOException On input error.
    */
    public double getNumber() throws IOException {}
    
    1. 单片机中的C语言(格式1)
    /*
    ******************************************************************************************
    *	函 数 名: TMC26X_ReadWriteByte
    *	功能说明: TMC26X读写一个字节函数
    *	形    参: val写入值
    *	返 回 值: 读回状态值
    ******************************************************************************************
    */
    UINT8 TMC26X_ReadWriteByte(UINT8 val)
    
    
    
    1. 单片机中的C语言(格式2)
    /**
     * @brief	开始输出指定频率的PWM波
     * @param	frequency PWM频率 单位:Hz
     * @retval	无
     */
    void BSP_PwmStart(uint32_t frequency) {}
    

    三、注释类型有哪些?

    其实一般没有这个概念,只是本文为了更好的解释说明注释的作用,给分别进行了定义。分别如下:

    • 翻译类型注释
    • 函数编写背景说明注释
    • 实现原理注释
    • 编程技术注释

    下面编写一个真实的函数来举例说明各种类型的注释:

    //此函数用于建立“温度”与“温度传感器电阻”之间的线性关系   //编写背景说明注释
    //函数:计算直线公式                             //翻译类型注释
    //功能:通过2个点来计算出直线方程的k和b              //原理类型注释
    //参数:w1 第一个温度值, 
    //参数:z1 第一温度值对应的温度传感器电阻值           //翻译类型注释,把字母翻译成有实际意义的名字
    //参数:w2 第二个温度值, 
    //参数:z2 第二温度值对应的温度传感器电阻值           
    //参数:k 计算出来的斜率                         //翻译类型注释,把一个字母翻译成实际对应的意义
    //参数:b 计算出来的截距          
    //返回值:无                                  //编程技术注释
    void JiSuanZhiXianGongShi( float w1, float z1, 
                            float w2, float z2,
                            float* k, float* b) {
        float temp_k; //临时变量
        float temp_b;
    
        //使用到饿直线公式为:y = k*x + b             //原理类型注释
        //以下代码通过“代入法”分别计算出k和b
        temp_k = (z2 - z1) /(w2 - w1);
        temp_b =  z2 - temp_k * w2;
    
        //通过指针类型形参返回计算结果                //编程技术注释
        *k = temp_k;
        *b = temp_b;
    }
    
    
    
    

    从以上代码注释实例中可以看到,“原理注释”和“背景说明注释”相对来说很重要,如果不写的话,阅读代码的人就看不懂代码。而其余的主要是“翻译类注释”,即把一个字符符号翻译转化为有实际意义的名字(解释其代表的意义)。

    四、“其实不用写注释”(^_^哈哈哈)

    以上说明文字和例子,充分举例说明了“代码注释”的重要性。但是也许你也发现这样一个现象。在实际编码工作中,大部分人是不写注释的。他们为什么不写。是偷懒吗?

    1. 嗯,是有偷懒的嫌疑,那么能给出偷懒的理由吗?理由如下:
    • 我写的是应用软件代码,有几万行代码等着我写,如果不是重要的注释,我是不写的。因为给每个函数都配一个汉语注释是不现实的。
    • 软件开发中,大部分注释是“翻译类型注释”,我只要把函数名字和变量名字起合适了,是不需要再去写啰嗦的注释(我要避免过度注释)
    • 切换中文输入法很麻烦,我英语比较好,同事也能看懂。因此我直接用“英语”写函数名字和变量名字即可。不需要写中文注释。
    • 写注释之后还要维护注释,否则注释反而造成了错误的引导,所以我干脆不写。
    • Linus Torvalds(Linux内核之父)给出的回复是:“Read the fu*king source code”。
    1. 嗯,以上的理由也挺充分。那么不写注释的代码是什么样子的,别人能看懂吗,请看如下代码。
    • 使用英语函数名字和变量名字代替“注释”(注意:仅保留原理类型注释)
    void Get_K_B_OfLinearFunction( float temperature1, float resistance1, 
                                float temperature2, float resistance2,
                                float* k, float* b) {
        float temp_k;
        float temp_b;
    
        //y = k*x + b 
        temp_k = (resistance2 - resistance1) /(temperature2 - temperature1);
        temp_b =  resistance2 - temp_k * temperature2;
    
        *k = temp_k;
        *b = temp_b;
    }
    
    
    • 使用合适的“拼音”变量名字代替“注释”(注意:仅保留原理类型注释)
    void HuoQuZhiXianFangChengDe_K_B( float wendu1, float dianzu1, 
                                float Wendu2, float dianzu2,
                                float* k, float* b) {
        float temp_k;
        float temp_b;
    
        //y = k*x + b 
        temp_k = (dianzu2 - dianzu1) /(wendu2 - wendu1);
        temp_b =  dianzu2 - temp_k * wendu1;
    
        *k = temp_k;
        *b = temp_b;
    }
    
    1. 要不要写注释的结论
      很显然,这两个函数例子中几乎没有写注释,仅注释了一个“直线方程的公式”。也就是说我们几乎没有“注释可看”,而我们可以看到的是“函数名字”和“参数变量名字”,然后再阅读函数中的代码实现。阅读代码的人可以准确的知道这个函数的真正功能。在理解的同时,还会对代码有一种“切实”的理解。因此调用这个函数的时候可以做到“心知肚明”。

      而如果只看注释不看代码,在调用函数的时候,就会有个“镜中花,水中月”的一种虚幻的感觉。因此还是的阅读一下函数实现代码。

      因此,最终的结论是:
      在良好“函数名字”和“变量名字”的辅助下(前提下),是不需要写“注释的”。如果要写,只要写“实现原理类型”和“设计背景说明类型”的注释即可。(另外可以专门去阅读一下大型开源软件的源码,看看大牛们是否写注释)。

    五、必须需要写完整注释的特例

    1. 接口函数
      另外要说明一点,在写接口函数的情况下,注释是要求“完完整整”写全的。比如常见的大公司提供的SDK。其中sdk内部实现功能的代码是不必写注释的。但是对外提供的“接口”函数,是必须要完整写注释的(包括函数功能,参数说明,使用方法说明,返回参数说明)。
    2. 硬件驱动函数(单片机程序代码函数)
      由于单片机的代码函数都和硬件紧密相关。函数中经常操作的的是“寄存器”,寄存器一般都是字母缩写。如果不写注释的话,那是真的无法看懂。其次,单片机的代码量相对应用软件来说代码很少,因此给每个函数都配一个中文注释是可接受的。因此要求“单片机”的程序代码都要写注释。
    展开全文
  • 优秀的程序员真的不写注释吗?

    万次阅读 多人点赞 2020-05-11 07:02:23
    我在很多地方看到这样一个观点,“请停止写注释,因为只有烂的代码才需要注释。”这个观点非常巧妙,它让我想起了孟子的一句话,“杨氏为我,是无君也;墨氏兼爱,是无父也。无父无君,是禽兽也。” 动不动就骂别人...

    我在很多地方看到这样一个观点,“请停止写注释,因为只有烂的代码才需要注释。”这个观点非常巧妙,它让我想起了孟子的一句话,“杨氏为我,是无君也;墨氏兼爱,是无父也。无父无君,是禽兽也。”

    动不动就骂别人是“禽兽”,我总觉得有点不妥,这很不符合孟子的浩然之气啊。有些大牛也有孟子这样的觉悟,如果有人要他给自己的代码加上注释,就好像是对他的一种侮辱:“我的代码写得这么优雅,你难道看不懂吗?注释是多余的!”

    我必须得承认,每个程序员都应该有一颗追求“优雅”的心,力争自己的代码更易阅读和理解——不只是针对机器,还有我们程序员同行。但不是每个程序员在一开始都能写出“高标准”的代码的,就好像不是所有君王和百姓都能搞清楚孟子的治国齐家理念的。

    在我刚回洛阳的那段时间,过得非常痛苦。因为我刚接手了别人留下的一个项目,关于大宗期货交易的。后端代码是用 Java 写的,但有很多 bug 在里面,动不动就资金结算失败,甚至内存溢出,要解决这些问题,只有一个办法,就是彻底搞懂这些代码。

    否则,根本无从下手。这就好像,你和朋友开车出去自驾游,去很远很远的地方,朋友开累了,需要休息,这时候,如果你没考过驾照,那就抓瞎了,只能把车停路边,等朋友的疲劳消退了,才能继续上路。

    我就抓瞎了。凭良心说,前同事留下的代码是精彩绝伦的,如果换做是我来写,真不一定能写得出来。毕竟大宗期货交易本身还是有点难度的,需要竞价撮合,这个业务理解起来比股票还要复杂些。

    股票涨了就赚,跌了就亏。期货不同的,买涨能赚,买跌也能赚。不过业务上的复杂还是次要的,重要的是代码里的注释非常稀有,就好像詹姆斯高斯林头上的发丝一样稀有。

    况且,国内程序员的英语功底你懂的,变量、方法、类、接口、枚举的命名无法做到真正意义上的名如其意。再加上,有些方法的行数多达三四百行,从头看到尾,看得只想捶自己。

    没办法,我的解决办法就是,看懂一行就加一行注释,毕竟注释总比代码要容易理解啊。就好像,我们在调用一个不熟悉的 API 时,只要代码的文档说清楚它是干嘛的,我们就可以用,就敢用,至于实现的细节,暂时没有理解也没关系。

    差不多花了两个月的时间(非常漫长、非常煎熬)吧,我总算是把项目中核心的代码给研究清楚了。搞清楚之后,那些之前怎么改都改不掉的 bug 也就迎刃而解了。

    这也就是为什么,我倡导大家去读源码的一部分原因了,除了学习,读源码是解决 bug 的杀手锏。要读懂源码,注释是必不可少的。不信,你看看 Java 的源码,每个变量、每个方法、每个类,注释都非常详细,详细到你替源码的作者感到心累。

    在我看来,Java 源码的作者绝对是这个世界上最优秀的程序员,连他们都写注释,那些声称“请停止写注释”的号召者是不是要啪啪啪地打脸,直到打肿为止。

    不要怀疑自己,写注释并不会证明你的代码就是烂代码。我相信,你应该买过电子产品,比如说鼠标、键盘、耳机、手机等等,所有的产品包装里除了产品本身,使用说明书是必不可少的。我就问一句,“手机没有使用说明书,咱这些后浪还能不会用?”

    写注释不是我们的错,软件本来就是复杂的。尤其是我们这些英语不是主力语言的人来说,注释显得尤为重要。我可能属于记忆力不好的那一种,隔个十天半个月,再去回头看那些我自己敲的代码,有时候真有点见着陌生人的感觉:“这代码是我写的吗?怎么有点面生啊?”

    大部分人写的代码都要升级重构,对吧?不论是语言本身版本的升级,还是我们自身能力的成长。假如在升级重构的时候,没有这些注释的帮助,真有点爬泰山的感觉,累啊,亲。

    再者说,大牛也不敢保证自己的代码是没有问题的,对吧?但注释是不会骗人的,它的意义是明确的。你可能会忘记代码是干嘛的,但我敢保证,注释能够唤醒你的记忆。

    写出好的、有意义的注释其实是有难度的,就像写代码一样。在追求卓越的路上,代码和注释其实是相辅相成的。注释会让你的代码更易阅读,代码会让你的注释更富有逻辑。

    即便是你的代码已经优雅到不需要注释,那只是在你的层面上。对于你的同事,你代码后来的负责者,就不一定了。所见略同的英雄并不会很多,你以为很优雅的代码没准在别人眼里就是一坨垃圾,而你的注释很可能会帮助别人“恍然大悟”,明白代码的意义。乖乖地写注释吧,对你对别人都有好处。

    另外,我想说一句,注释就好像是代码的一个蓝图,也或者是对代码的一个总结。在你写代码之前,脑子里肯定要想清楚你要实现什么,怎么实现,把这些作为注释写下来绝对可以帮助你写出更优雅的代码。在代码写完之后,通过注释进行总结,还能对代码进行一些升华,没准还能在总结的过程中想到更好的代码方案。

    我还见到有大牛信誓旦旦地说,写注释就好像是给不会游泳的人扔一个救生圈,他永远也学不会游泳。咋眼一看,这句话说得很有道理,对吧?在大牛们看来,要让一个新人快速成长,最好的办法就是把没有注释的代码扔给他看。

    纯属扯淡,恐怕这个新人没入门就放弃了吧?我已经三十一岁了,不,我已经十八岁了,还不会游泳呢?别听那些大牛们的鬼话,我就不信,他自己没写过注释。

    总之一点,注释并不会妨碍你写出优雅简洁的代码,它只是程序固有的一部分而已

    如果觉得文章对你有点帮助,请微信搜索「 沉默王二 」第一时间阅读。本文已收录 GitHub,传送门~ ,里面更有大厂面试完整考点,欢迎 Star。

    我是沉默王二,一枚有颜值却靠才华苟且的程序员。关注即可提升学习效率,别忘了三连啊,点赞、收藏、留言,我不挑,嘻嘻

    展开全文
  • 我只写注释 —— 让Ai写代码

    千次阅读 多人点赞 2022-04-03 13:05:34
    活在风浪的博客-CSDN博客https://blog.csdn.net/m0_57904695/article/details/123881330 在vsCode中下载copilot 注册账号,官网GitHub Copilot · Your AI pair programmer 等待开通 通知 ...

    前期回顾    

    Vue项目实战 —— 哔哩哔哩移动端开发—— 第二篇_0.活在风浪里的博客-CSDN博客https://blog.csdn.net/m0_57904695/article/details/123881330


           它很强,提示强,代码风格强,内容多,小明:“怎么说,你举个例子吧”。行,念及此!

         例如你写了上文的倒计时注释或函数封装,但是没调用,当你用到这里直接灰色文字提示,你只需要按下tab,自动补充,不仅如此,你的调用它帮你完成,就连wacth监听或是要在mounted调用它也会提示你,一句话Ai会将你需要的代码和注释提示于你,和你需要用的重合度极高 极高

     

    在vsCode中下载 copilot 

     注册账号,官网GitHub Copilot · Your AI pair programmer

    利用页面翻译软件

    等待开通 通知 

    应该1-2天时间就会开通,具体时间不知,耐心等候内侧通知,可以再次点击官网去查看,出现如下就可以拉取代码,之后就可以使用 copilot 

     

     

    这是我写的倒计时源码,小伙伴可以去试试

    <template>
        <div class="login">
            <el-input v-model="phone" :suffix-icon="icon" class="inp"></el-input>
            <el-button type="primary" v-if="flag" @click="getCode" :disabled="dis">获取验证码</el-button>
            <span v-else>获取验证码还有{{ num }}秒</span>
        </div>
    </template>
    
    <script>
    export default {
        data() {
            return {
                phone: "",
                num: 5,
                flag: true,//按钮和验证码的切换条件
                icon: 'el-icon-close',
                dis: true
            };
        },
        methods: {
            getCode() {
                this.flag = false
                let timer = null;//每次点击都会先赋值成null,防止用户快速多次点击,造成
                //定时器队列
                timer = setInterval(() => {
                    //点击按钮如果num大于等于1就--,
                    if (this.num >= 1) {
                        this.num--;
                    } else {//点击按钮如果没有大于等于1,说明小于1,就恢复成按钮状态
                        clearInterval(timer);
                        this.flag = true;// 时间小于5秒,按钮变成可点击状态          
                    }
                }, 1000);
            },
            phoneReg() {
                let reg = /^(?:(?:\+|00)86)?1(?:(?:3[\d])|(?:4[5-79])|(?:5[0-35-9])|(?:6[5-7])|(?:7[0-8])|(?:8[\d])|(?:9[189]))\d{8}$/
                if (reg.test(this.phone)) {
                    this.icon = 'el-icon-check'
                    this.dis = false
                } else {
                    this.icon = 'el-icon-close'
                    this.dis = true
                }
            }
    
        },
        
        watch: {
            phone: {
                // deep: true,
                // immediate: true,
                handler(newVal, oldVal) {
                    // 其实将phoneReg这个函数直接写在这里也可以,
                    // 但是为了结构更加清晰,尽量的将逻辑抽离,这样一眼明了!
                    this.phoneReg()
                },
            },
        },
    
    
        
    
    
    };
    </script>
    
    <style lang="scss" scoped>
    .login {
        padding: 15px;
        /deep/ .el-input__inner {
            height: 50px;
            border-radius: 5px;
        }
        /deep/ .el-input {
            width: 400px;
            margin: 15px;
        }
        /deep/ .el-icon-check {
            color: green;
            font-size: 25px;
            line-height: 50px;
        }
        /deep/ .el-icon-close:before {
            font-size: 25px;
            color: red;
            line-height: 50px;
        }
    }
    </style>
    

    结语:

    祝大家越来越好 

    展开全文
  • 教你代码注释

    千次阅读 2019-12-08 21:35:31
    这时候,代码注释就可以发挥它的作用了——提高晦涩难懂的代码的可读性;注释可以起到隐藏代码复杂细节的作用,比如接口注释可以帮助开发者在没有阅读代码的情况下快速了解该接口的功能和用法;如果的好,注释还...
  • 一个描述你想要的逻辑的注释,让 GitHub Copilot 为你生成代码。 用您喜欢的编程语言 GitHub Copilot 使用广泛的框架和语言。技术可视化特别适用于Python,JavaScript,TypeScript,Ruby,Java和Go,但它也可以...
  • 程序员的代码注释需要么?

    千次阅读 2021-11-01 15:13:15
    “别给糟糕的代码注释——重新吧。”—Brian W. Kernighan与P. J. Plaugher 什么也比不上放置良好的注释来得有用。什么也不会比乱七八糟的注释更有本事搞乱一个模块。什么也不会比陈旧、提供错误信息的注释更有...
  • 写注释她帮你写代码

    千次阅读 多人点赞 2022-04-23 09:52:55
    打开邮箱看到如下邮件后还是小...你只要注释,它就可以帮你转换成代码(中文注释也可以哦) 根据你代码的上下文帮你自动补全重复的代码 目前支持多种开发语言,包括 Python, JavaScript, TypeScript, Ruby, Ja
  • 写注释就能自动出代码?copilot 尝鲜

    千次阅读 2021-10-09 00:26:36
    它有自动提示,根据注释写代码等诸多激动人心的功能。 更多功能以及最新动态请访问官方网站:https://copilot.github.com/ 后台回复:typescript,获取我写的 typescript 系列文章,绝对精品 后台回复:电子书,自动...
  • 避免在代码里写注释

    千次阅读 多人点赞 2013-03-14 14:21:45
    如果用很多注释来“装饰”代码是件好事的话,那么在代码中加入大片大片的注释便是锦上添花了。是这样吗?事实上不完全是这样的。过犹不及,好心也会办坏事。 '************************************************* ' ...
  • 代码注释怎么

    万次阅读 2017-05-15 00:20:33
    注释怎么写注释的作用是什么?我认为注释最终作用无非就两个。 1.和伪代码一样的作用,为接下来要实现的功能出一个指导性的算法思路。只是没有伪代码详细。但是也指出了完成此功能的大体算法思路。 2.给看代码...
  • 关于代码注释的几种方法

    千次阅读 2022-02-08 16:44:56
    vs中常见的注释方法
  • Python 中如何写注释

    千次阅读 2020-11-25 19:37:41
    Python 代码的时候,一个很好的编码实践就是使得...例如,如果你了一个复杂的正则表达式,你可以添加一个注释,描述代码做了什么。在你的 Python 代码中添加注释,在将来你阅读你的代码时,可以节省很多的时...
  • C语言如何注释一段代码

    千次阅读 2021-05-19 11:28:23
    在编写程序时,为了使代码易于阅读,通常会在实现功能的同时为代码加一些注释注释是对程序的某个功能或者某行代码的解释说明,它只在C语言源文件中有效,在编译时会被编译器忽略。C语言中的注释有两种类型,具体...
  • 程序不愿意写注释的问题

    千次阅读 2018-02-03 17:53:26
    结构清晰简单、很容易维护的代码可以少甚至不写注释多了注释反而会降低工作效率。 代码越复杂越不容易维护,维护的人越是参差不齐,越是需要认真写注释。 判断注释、文档的够不够其实很容易验证。如果代码...
  • idea怎么写注释

    千次阅读 2020-11-29 00:12:14
    1.单行注释: // 2.多行注释: /* / 也可以选中代码按住Ctrl+Shift+/ 3.在类的上一行输入 /** 可以弹出自带注解
  • 为什么要给代码添加注释

    千次阅读 2021-07-06 15:54:44
    在编写程序时,为了使代码易于阅读,通常会在实现功能的同时为代码添加一些注释注释是对程序的某个功能或者某行代码的解释说明,它能够让开发者在后期阅读和使用代码时能更容易理解代码的作用。 注释只在Java...
  • “几个月前,我代码只有我和上帝知道” “现在,只有上帝知道了” 最近在知乎上看到了这个话题:怎样看待程序员不写注释? 看了下浏览量居然有 30+w 次,看来大家讨论的挺热闹,我浏览了大部分的回答,发现...
  • 代码注释规范

    千次阅读 2019-01-07 15:05:13
    代码注释规范 一、后端代码注释 1.类(接口)注释 (1)使用swagger的项目 @Controller @RequestMapping("/testController") @Api(value="Controller的描述") public class TestController { ......
  • VScode 代码注释

    千次阅读 2020-08-26 15:53:32
    MAC: 单行注释/取消注释: command+/ ...常用于给方法写注释在方法上时会自动带上此方法的参数,而且会车自动带上‘*’ tips:快捷键VScode左下角设置可查(妈妈再也不用担心我记不住快捷键啦) ...
  • 如何给python代码快速添加注释

    千次阅读 2021-02-10 06:24:12
    python代码快速添加注释的方法选中要注释代码,按下ctrl+/注释。实例#----->1.用一对"""括起来要注释代码:"""number=23guess=int(raw_input('Enteraninteger:'))ifguess==number:print'Congratulations,...
  • 本篇文章主要讲解,通过工具实现保留路径并批量无损删除,项目中的代码注释的方法 作者:任聪聪 做完了项目,但是里面有很多的注释不想让其他人看到,但是自己手动删除又很麻烦,用idea删除又害怕删错,这时候我们...
  • 注释----->该怎么/单行/多行/文档

    千次阅读 2021-03-13 17:39:41
    几行代码也许很容易知道功能,但几百行的代码,多个文件,也许刚的时候是知道功能与特性的,但是随着时间的流逝,对自己的代码越来越难以理解,更别说其他人了。代码的可读性巨差,影响编程开发效率。注释的分类1 ...
  • 代码不完,还个锤子注释

    千次阅读 多人点赞 2021-10-22 16:00:49
    现在的项目开发代码注释就像程序员的头发,越来越少。 尤其是国内,这种现象不仅是在小公司小团队中司空见惯,就算在大公司,以及大团队中的开源项目,也是屡见不鲜。 上图是我在阿里的 Druid 项目源码...
  • python中注释代码的方法汇总

    千次阅读 2021-03-17 19:09:22
    一、python单行注释符号(#)python中单行注释采用 #开头示例:#this is a comment二、批量、多行注释符号多行注释是用三引号,例如:输入''' '''或者""" """,将要注释代码插在中间三、Windows下的IDLE的注释快捷键...
  • python中的代码如何进行注释

    千次阅读 2021-01-29 18:45:31
    python中的代码如何进行注释发布时间:2020-09-03 10:49:23来源:亿速云阅读:62作者:小新这篇文章主要介绍了python中的代码如何进行注释,具有一定借鉴价值,需要的朋友可以参考下。希望大家阅读完这篇文章后大有...
  • 对于类中的注释,我们可以通过IDEA自动生成。 如IDEA 可以通过:File->Settings->Editor->File and Code Templates->Includes->File Header来设置模板,这样新建文件时,IDEA会按照设置的模板,会...
  • 如何写注释

    千次阅读 2018-09-20 09:32:36
    如果能从代码本身看出的事实写注释。 这样注释完全多余,从代码本身就可以看出代码的意思。 也不能使用跟代码一样的意思重复注释,比如: //Find a Node with the given 'name' or return NULL Node * ...
  • 代码快速注释(快捷键)

    千次阅读 2021-12-09 23:41:51
    方法一:Ctrl + / 方法二: 开启注释 ctrl + K再加上C 消除注释 ctrl + K 再加上 U 方法三:Alt + Shift + A

空空如也

空空如也

1 2 3 4 5 ... 20
收藏数 1,565,469
精华内容 626,187
关键字:

代码里写注释怎么写