首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往
您找到你想要的搜索结果了吗?
是的
没有找到

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

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

3.9K40

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

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

15520

代码注释怎么:打造优质代码的技巧

在编程中,有一种无声的艺术,那就是代码注释。这可能看起来微不足道,但其实非常关键。它不仅有助于他人理解你的代码,也是自我表达的一种方式。为什么注释?...在我们深入细节之前,先让我们探讨一下为什么注释如此重要。增加可读性:好的注释能增加代码的可读性,让其他人更快理解你的代码逻辑。...协作:在 团队项目 中,注释是沟通的桥梁,能帮助团队成员理解代码的意图和实现方式。维护:在后期对代码进行修改或优化时,注释能帮助快速定位和理解代码段落的功能。...好的注释实践接下来,我们将探讨一些好的注释实践,展示示例代码,并讨论在不同技术场景下的应用。单行注释单行注释适用于简单说明一行代码的作用。...结语写出好的代码注释,就像在众声喧哗中找到和谐的旋律。它不仅赋予代码以声音,也让后来者能在这声音中找到方向。

7110

如何在js文件中加载Applet控件(jsjsp分离技术)

如何在js文件中加载Applet控件(jsjsp分离技术) 我们在代码的时候,一般喜欢将JSPJS实现分离开,将页面部分的代码写在.jsp结尾的文件中...Javascript中经常有一部分代码是动态产生的,导致我们经常不得不将这部分代码写到jsp文件中,这就导致代码看起来不雅和难懂。那么我们有没有办法将需要写到jsp页面上的代码写到js文件中呢?...我们可以这样实现,在jsp一个空的div,这样,页面加载这个div是不耗性能的。...你可能想说,我如果将把js写成公共的文件,可以供很多jsp调用,那些jsp页面也不在需要写死一个名为testDiv的对象,那怎么办呢?...由于js页面不知道jsp在哪个地方加载js文件,所有像原先那样一个相当位置的div是不大妥当的,而加载一个固定位置的div,则无论jsp在哪个地方加载js文件,都可以保证div想固定的地方显示了。

7K40
领券