SpringSide团队日志

规范化我们的JAVADOC

作者 johnsonchen 目标文章 项目日志 - 2006-05-10

    虽然现在springside代码的注释也不算少,但还是写得不规范,生成的javadoc非常没有卖相。看看spring的doc,会发现老外的doc写得帅多了。希望各位同学在开发的时候注意一下,规范一下doc的写法,如类doc记得写@version,@auth,@since, 方法doc里加多点@param,@return, @throws, @exception, 多用@see,@link来加强类,方法间的粘滞性,详细可见一篇中文JAVADOC规范(http://www.iplab.cs.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/win32/javadoc.html) 。向spring看齐,让springside正规化 ^_^



  1. sigh 评论

    2006-05-12 13:07

    这些东西项目开始就应该动手的吗,除非真个团队只是在自娱自乐,现在的东西拿出来真的还不像个样子 :)

发表评论








 authimage