JAVA项目文档中需要注意哪些东西

发布网友发布时间：2022-04-26 02:50

共2个回答

热心网友时间：2022-06-20 05:55

保持良好的编码习惯，缩进、空行等等。

加入必要的文档和版本说明，而不是见地方就加，有的时候代码本身能说明问题。

此外，可以在详细设计里适当画一些UML图，帮助理解你的代码

热心网友时间：2022-06-20 05:55

说一下我的做法，
如果我对某个东西极少听说，只是刚接触，那么我会在网上先找看有没有入门资料，入门的例子，比如：helloWolrd例子，然后跟着实现一个

如果我这个东西有一定的了解，那我就会看它里边有没有使用的例子，一般的项目都会带一些使用的范例，如struts2中的apps目录，类似的，我们可以找example等目录看看，有例子就尝试把它部署运行起来，对照源码和文档，自己再实现和改进试试

也会找找看有没有视频教程，反正多管齐下嘛，适合自己就行

听说高手都是直接看文档和自带的例子的，这样能省不少时间，可惜我现在是做不到的

当然了，就像楼上说的，不管哪种方式，都肯定是要自己动手去写去实践的，否则只能是空谈