原文:如何写出格式优美的javadoc?

如果你读过Java源码,那你应该已经见到了源码中优美的javadoc。在eclipse 中鼠标指向任何的公有方法都会显示出详细的描述,例如返回值 作用 异常类型等等。 本文主要来自 Thinking in java 的内容以及我在工作中写javadoc的经验。 三种类型的注释文档 注释文档有三种类型,分别对应于注释位置后面的三种元素:类 域和方法。也就说类注释正好位于类定义之前 域注释位于域定义之 ...

2018-02-23 23:13 2 7787 推荐指数:

查看详情

如何写出优美的代码(三)

(该文思想来自于经典著作《编程珠玑》) 看到有朋友评论说,美的代码不仅仅是规范上面的事。规范的代码可以让我们减少Debug的难度,增加可扩展性。当遇到性能问题的时候,我们就需要改进算法了。 编程珠玑的开篇提到了一个给最多一千万个7位电话号码排序的问题。首先我们看这个问题的常规解决方案 ...

Wed Mar 14 09:14:00 CST 2012 4 2537
如何写出优美的代码(一)

(本文思想基本来自于经典著作《重构》一书) 我愿意把代码想象成女性,我希望在我面前的是一个美女,受不了丑陋的那部分。 优美的代码可理解性高,修改成本低。不过优美的代码是不容易一次写出的。我的代码刚刚写完就是一坨屎。 比如有很多重复代码,同一个类的两个函数含有相同的表达式。 函数 ...

Mon Mar 05 09:22:00 CST 2012 10 5432
如何设计出优美的Web API?

热文索引,坚持原创不易,请小伙伴们不吝「推荐」支持: 1. 程序员必须掌握的性能调优 X Y Z 2. 程序员必须懂的架构入门课 1 2 3 3. 如何把单体式应用拆解成微服务?【上】 4. 如何把单体式应用拆解成微服务?【下】 5. 如何写好产品帮助文档? 概述 ...

Tue Dec 24 17:22:00 CST 2019 21 5082
CoffeeScript 更优美的Javascript

CoffeeScript 是一门编译到 JavaScript 的小巧语言. 在 Java 般笨拙的外表下, JavaScript 其实有着一颗华丽的心脏. CoffeeScript 尝试用简洁的方式展 ...

Thu May 19 23:48:00 CST 2016 0 3374
如何实现优美的骨架屏

对于前端来说,最重要的莫过于用户体验了,这次我们聊一聊骨架屏 - Skeleton Screen 我们平常对于需要请求加载的内容,可能用的比较多的是loading动画,比如在内容区域放一个菊花图,当 ...

Tue Dec 10 17:35:00 CST 2019 0 247
Django——优美的Path()函数

path( )作用:解析URL地址 path( ) 标准语法: (<>为必须的参数,[]为可选参数) path(<route>, <view>, [name=N ...

Sat Sep 28 04:13:00 CST 2019 0 1894
如何写出“好代码”

一、前言   项目中使用 Design Pattern 越多越好?   哪种 Pattern 比较重要?   需要学习哪些 Pattern ?   代码是否可测试?   对于入门者来说,直 ...

Mon Feb 01 02:15:00 CST 2021 0 426
如何写出好代码

如何写出好代码 这个题目把我自己都看傻了,因为仔细想想,这不是一个命题,是对代码的思考,对细节的推敲和打磨。写好代码是一门学问,还是一种修行。 以前是公众号(JackieZheng)和博客同步更新,尤其是技术类文章。但是最近在公众号上写的比较多,因为在那我可以想写多少写多少,随时随地记录 ...

Mon Mar 27 03:12:00 CST 2017 12 3961
 
粤ICP备18138465号  © 2018-2025 CODEPRJ.COM