写点什么

代码注释

0 人感兴趣 · 13 次引用

  • 最新
  • 推荐
https://static001.geekbang.org/infoq/b0/b0b9665bddf467264132145a457837b6.png?x-oss-process=image%2Fresize%2Cw_416%2Ch_234

代码注释的艺术,优秀代码真的不需要注释吗?

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

https://static001.geekbang.org/infoq/ed/edfc7d381eb85cd9de035adce76b64d9.jpeg?x-oss-process=image%2Fresize%2Cw_416%2Ch_234

把 Mybatis Generator 生成的代码加上想要的注释

在日常开发工作中,我们经常用Mybatis Generator根据表结构生成对应的实体类和Mapper文件。但是Mybatis Generator默认生成的代码中,注释并不是我们想要的,所以一般在Generator配置文件中,会设置不自动生成注释。带来的问题就是自动生成代码之后,我们还要

你不得不掌握的前端提交规范(git cz)

用户头像
你好bk
2021-12-10

最近在提交代码的时候发现每次提交的代码说明都是层次不齐的,看上去让人感觉到特别的凌乱。第一:让人看上去感觉这个程序猿好像不是“正规”出身,再一让自己在回溯代码的时候没有任何头绪。

【译】JavaScript 代码整洁之道 - 注释篇

用户头像
KooFE
2021-06-04

在这篇文章中,我们将要讨论开发人员书写整洁代码时很有争议的一个主题:注释。部分人认为,对代码进行注释是一个好的实践,但也有一部分人完全相反,认为注释不是好的做法。

为啥你写的代码总是这么复杂?

摘要:有句话说得很好,“代码质量决定生活质量”,当你把软件的复杂性降低了,bug减少了,系统可维护性更高了,自然也就带来了更好的生活质量。

教你写好代码注释

用户头像
元闰子
2021-05-04

注释是软件开发过程中的性价比极高的一个工具,它只需要花费20%的时间,即可获取80%的价值。代码注释最重要的作用就是让读者可以在不读源码的情况下,快速了解一段代码的主要功能。

https://static001.geekbang.org/infoq/67/67faca721ec56ab099c05525b53af731.jpeg?x-oss-process=image%2Fresize%2Cw_416%2Ch_234

Rust 从 0 到 1- 基础概念 - 注释

用户头像
2021-03-29

Rust语言中注释的使用。

这 5 个让人窒息的烂代码,你看完都忍不了

摘要:下面就为大家带来个人认为的常见的烂注释风格。

https://static001.geekbang.org/infoq/ea/eaedc4b3d97850d556d5e30827dfe7d0.jpeg?x-oss-process=image%2Fresize%2Cw_416%2Ch_234

JDK8 Unsafe.java 源码

用户头像
Darren
2020-09-03

最近在整理回顾多线程的东西,CAS是必不可少需要关注的重点,在Java中,CAS主要是通过Unsafe实现的,但是在IDEA中打开,看见的是class文件,并不是源码,没有注释,看起来非常的费解,因此找到了该类的源码,作为查看学习的记录。

可读代码编写炸鸡四 (上篇) - 来写注释

用户头像
多选参数
2020-06-30

这一篇炸鸡要讲一讲 代码注释 的可读性优化。附思维导图哈~

可读代码编写炸鸡三 - 审美

用户头像
多选参数
2020-06-30

围绕 多行代码,多个函数 的代码范围来讨论代码可读性的优化。

代码注释_代码注释技术文章_InfoQ写作社区