写点什么

代码注释

0 人感兴趣 · 10 次引用

  • 最新
  • 推荐

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

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

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

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

教你写好代码注释

用户头像
元闰子5 月 4 日

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

https://static001.geekbang.org/infoq/67/67faca721ec56ab099c05525b53af731.jpeg?x-oss-process=image/resize,w_416,h_234

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

用户头像
3 月 29 日

Rust语言中注释的使用。

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

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

https://static001.geekbang.org/infoq/ea/eaedc4b3d97850d556d5e30827dfe7d0.jpeg?x-oss-process=image/resize,w_416,h_234

JDK8 Unsafe.java 源码

用户头像
Darren2020 年 9 月 3 日

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

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

用户头像
多选参数2020 年 6 月 30 日

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

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

用户头像
多选参数2020 年 6 月 30 日

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

https://static001.geekbang.org/infoq/64/64e312e76c438dffa207ebb79e63ff4f.png?x-oss-process=image/resize,w_416,h_234

Cocoa 代码注释与文档生成

用户头像
Edmond2020 年 6 月 19 日

如何基于 Jazzy 生成 CocoaPods 文档

代码注释_代码注释资料文章-InfoQ写作平台