接口、实现类先写哪个?在哪个里面写注释才是标准的做法?还是接口与实现都写注释(貌似很少这样的哦)

cto_1st 2011-03-18 08:58:23
大家知道,在编写代码(程序)的时候,往往出于对程序代码的耦合性的考虑,采取接口编程。
曾见一位前辈这样编写过代码,在myeclipse中写好一个类,里面有各种各样的方法存在。
然后右键该类 Refactor-extract intface 。
但是小菜在平时的学习中老师的教法是,先写好接口,然后再 写实现该接口的实现类。

有几点小疑问在此提出,(第一次发帖,请大家多多包涵)
1.接口与实现类的先后顺序如何。
2.接口与实现类中在哪一个里面写注释。

答案可能会因为大家的编码习惯而出现各异,请各位前辈多多解惑、在此十分3Q
...全文
1820 3 打赏 收藏 转发到动态 举报
写回复
用AI写文章
3 条回复
切换为时间正序
请发表友善的回复…
发表回复
huntor 2011-03-20
  • 打赏
  • 举报
回复
在方法注释里使用 {@inheritDoc}
cto_1st 2011-03-20
  • 打赏
  • 举报
回复
恩。谢了。第一次发帖,还好有位朋友来捧场了,呵呵
龙四 2011-03-18
  • 打赏
  • 举报
回复
理论上是先写接口再实现类,但在实现类的过程中又可能回去修改接口

一般在接口中写方法注释,生成javadoc的那种

在实现类中写实现方式相关的注释
由于一时的头脑发热,花了两个晚上基于AxWebBrowser了一个浏览器MyIE。现在用这个浏览器发的帖子,有点小市民的成就感,嘿嘿。源代码可以在本人的资源里下载到,这里简单总结如下:

1、VS2005自带的WebBrowser功能较少(网上资源也不多),AxWebBrowser控件暴露的事件更多些。比如打开新窗口的控制,WebBrowser貌似没有简单的方法来实现

2、实现标签式界面,难点有:1)所有标签共用一个地址条、状态条、导航按钮,要切换上下文,要把界面状态封装起来,我封装到 BrowserData 类里,寄存在 TabPage.Tag 属性里;2)关闭一个Tab页时,默认会激活第一个Tab页,而不会回到上一个标签,我设计了一个标签栈(_pageStack)来管理;

3、实现了状态条,赞叹VS2005的 ToolStrip 功能强大,使用起来太方便了!感谢为我们铺路的工作者们!

4、实现了收藏夹功能,跟IE实时同步,其实也很简单,就是打开 Favorite 目录,遍历目录和子目录,解析链接文件;另一个难题是调出 IE 界面,例如“Internet 选项”“整理收藏夹”“添加到收藏夹”等;

5、集成了Google、百度搜索。

6、实现了输入框的自动完成,跟IE的效果完全一致。这里再次赞叹 ToolStrip 控件的强大~~

7、实现了地址条输入框历史记录管理、搜索关键字历史记录管理

8、花的时间很短,bug很少,不过代码没什么注释,读者就费点眼神吧,呵呵 :-)

58,453

社区成员

发帖
与我相关
我的任务
社区描述
Java Eclipse
社区管理员
  • Eclipse
加入社区
  • 近7日
  • 近30日
  • 至今
社区公告
暂无公告

试试用AI创作助手写篇文章吧