首页
学习
活动
专区
圈层
工具
发布

代码里注释写太多,会挨打吗?

前几天,有个同行朋友在我的微信上留言,问我项目代码里注释写太多会挨打吗?顺手还给我甩了一张截图,上面密密麻麻的全是手工注释。 ? 看完之后,我跟她说,挺好的,我已经备好手枪了。...「 如何把握这个尺度 」 代码里写注释,如何才叫多,什么是多,什么是少,如何才能把握这个尺度? 还记得老前辈的话犹在耳畔,一份经久不衰的代码,注释量与代码量的比例应该至少为 2:1。...什么代码都不写注释 2. 什么代码都写注释 3....注释里参数是字符串类型, 代码里却是布尔类型. 所以,此处为什么是前同事?因为代码不规范,老板给他放长假了。...请记住,这是一句装逼话,群里吹水你也信,你看看Vue.js源码里有多少注释(杠精不要跑过来跟我说,/* 英文的注释不算 */ )。 Are you sure ?

5K40
  • 您找到你想要的搜索结果了吗?
    是的
    没有找到

    【js】如何正确的写代码注释?

    */ function formTime(time,isyear){ } 简单的变量声明之类的内容可以进行简单注释,但是函数就不能这样做了,要知道注释的作用是一种为了让代码更易读...formTime(time,isyear){ } 是不是比之前的注释多了很多,内容详细了很多,当然,不只是单单的内容多了,如果只是内容多了那么/* */段落注释同样也可以写,...普通注释 文档注释 这种提示就像嵌代码在里面一样,而不是浮于表面了,在我们书写npm包的时候,用户使用我们的包,就能看到这种提示,对使用者特别友好。...npm install jsdoc -g 基本使用 jsdoc 文件名 其他的使用方式可以去官网查看 jsdoc 33.js 执行完此命令,会生成一个out文件夹,查看里面的index页面即可,右边侧边栏会显示函数的使用

    2.1K20

    PHP 标准库的价值远不止少写几行代码

    PHP标准库的价值远不止少写几行代码无论是基于全栈框架构建的应用、采用微服务框架并搭配精心挑选的独立库的服务,还是CMS扩展,所有PHP项目都有一个共同点:它们都使用PHP标准库。...但要将它们组合成一个协调运作的应用,就意味着每次跨越两个库之间的边界时,都需要增加胶水代码。这也意味着,每位开发者都必须学习某个库所使用的“方言”。PHP本身也不例外。...只需四行PHP代码,就能完整描述它:展开代码语言:PHPAI代码解释enumSortDirection{caseAscending;caseDescending;}在自己的库中实现它轻而易举,但如果多个库各自实现了...一个规模小、设计正确、考虑了未来演进的API,很容易扩展;一个规模庞大却存在些许设计偏差的API,则会在未来数十年里持续带来麻烦。Time\DurationRFC展示了这一原则如何落实。...[原文-PHP标准库的价值远不止少写几行代码](https://catchadmin.com/post/2026-11/designed-once-usable-everywhere-an-investment-in-php-standard-library

    3610

    php写接口入门

    格式转化 学习了php的基本语法的你们肯定知道数组Array这个基本数据啦,因为我们前端显示出的数据库数据一般由数组表示的,那么基本数据数组和JSON之间要怎么转换呢?...json四原则: “:”:数据在名称/值对中 “,”:数据由逗号分隔 “{ }”:花括号保存对象 “[ ]”:方括号保存数组 写php接口 个人写接口的时间不长,从网上资料及视频教程中得出经验:写简单接口...,就相当写MVC中的MC,只写逻辑代码层,把功能用函数封装起来,到时候include,直接调用就好了。...\r\n"; 接口存在的意义就是实现“多重继承”,准确的来说应该就做“多重实现“,因为一个php类只能有一个父类,而一个类却可以实现多个接口,就像大一学C++时,上面代码interface.php中的Hybreed...,希望对大家的学习有所帮助,也希望有写接口经验的大牛们加我微信(wzc88czw)交流学习心得。

    11.5K81

    php myadmin写shell

    有时候在渗透测试过程中 我们会得到php myadmin 的账号和密码 既然登陆了php myadmin 就可以用php myadmin 来get shell。...具体内容 简单说明 登陆进php myadmin 有些朋友可能会直接选择去写入一个webshell 执行后会弹出大概无法写入的意思 这里和php myadmin的设置有关系 在实战情况下一般都不能直接去写入一个...路径改为网站的根目录 set global general_log = "ON"; set global general_log_file='D:/stduy/PHPTutorial/WWW/infos.php...'; 执行完后因为我是本地搭建环境所以可以看到成功创建了 现在我们只需要输入一个错误的sql语句即可 这里我写入一句话 可以看到一句话已经存在于infos.php里面了 之后我们菜刀直接链接即可 总结...网上有许多相关的文章 不过自己写一遍印象才会更深刻吧

    2.4K20

    绕过JS写爬虫

    http://data.eastmoney.com/jgdy/tj.html       我们希望抓取的是js生成的表格。      ...这种带有js的网站抓取其实不是那么简单的,基本分为那么几种方法,一种是观察页面,有的会有json数据,有的有js代码可以解析目标的url;一种是使用渲染工具;还有一种就是用工具来点击相关button,来抓取...我们希望爬取的是表格中的数据,但是如果我们仔细看一下html代码,会发现,这其实是js生成的,下面这张图是源代码的截图。 ?       这就很尴尬了,怎么办呢?...然后我们就点击第二页、第三页不断的来观察究竟js代码访问了什么后台的url。...pagesize=50&page=1&js=var YnQNqDYj¶m=&sortRule=-1&sortType=0&rt=50585869 http://data.eastmoney.com

    17.7K20

    js写插件教程

    ="11" /> add //这里是插件的代码...;我为了方便都写到一个html中了;请把这个script标签中的内容单独写在一个js文件里 //整个插件写在一个立即执行函数里;就是function(){}();函数自执行;保证里面的变量不会与外界互相影响...号(叹号)或者;(分号)这不是写错了,为了防止那个二货写的js结束没有分号;而可能发生报错 /* ;function(win,doc,$,undefined){ }(window...//我们随便写一个插件吧 比如你要点击按钮 添加input的值到 div里 var addHtml = function(demo,btn){//插件名,调用的时候直接new一下插件名就行了并传参数或者传对象...addHtml.prototype = {//给函数写方法;这里可能不止一个函数;你还记得你在全局里写一个个的function吗;贼乱; //找也不好找;把一个个函数都写到对象的属性里;

    42.5K10

    用最古老的 WordPress 系统,写最现代的 PHP 代码!

    我们知道 WordPress 的函数在失败的时候,是不会抛出异常的,因为 WordPress 在 PHP 4 的时候就创建了,那时候 PHP 语法结构还没有 try/catch 异常处理机制。...WordPress 还提供了 is_wp_error 函数,用于判断接受到数据是不是 WP_Error 对象,这样我们在写代码的时候,就需要自己判断返回值是不是 WP_Error 对象,然后进行额外处理...,做了一些简化,留下大致的骨架,可以看出快速复制文章有三个过程,注释里面已经写的非常清楚,下面简单说一下 获取旧文章信息,并插入新文章,如果 WP_Error 对象,则直接返回。...可以把 WP_Error 对象转换成 PHP 异常继承类的对象,然后使用现代 PHP 的 Try / Catch 异常处理机制来优化。...这样就可以在 WordPress 写代码的时候,避免满屏幕的错误处理,最后返回还是 WP_Error 对象,保证了对原来逻辑的兼容。

    83120
    领券