黑马程序员技术交流社区

标题: 说明文档为什么要写在函数之上 [打印本页]

---

作者: 梦幻    时间: 2014-3-21 20:44
标题: 说明文档为什么要写在函数之上


这是一个冒泡排序的小程序，为什么其中的说明文档一定要写在函数之上，其中有什么关联？

public class BubbleSort {
        public static void main(String[] args) {
                // 创建一个数组，这个数组元素是乱序的
                int[] array = { 63, 4, 24, 1, 3, 15 };
                // 创建冒泡排序类的对象
                BubbleSort sorter = new BubbleSort();
                // 调用排序方法将数组排序
                sorter.sort(array);
        }
        
        /**
         *冒泡排序
         *
         * @param array
         *            要排序的数组
         */
        public void sort(int[] array) {
                for (int i = 1; i < array.length; i++) {
                        // 比较相邻两个元素，较大的数往后冒泡
                        for (int j = 0; j < array.length - i; j++) {
                                if (array[j] > array[j + 1]) {
                                        int temp = array[j];// 把第一个元素值保持到临时变量中
                                        array[j] = array[j + 1];// 把第二个元素值保存到第一个元素单元中
                                        array[j + 1] = temp;// 把临时变量也就是第一个元素原值保持到第二个元素中
                                }
                        }
                }
                showArray(array);// 输出冒泡排序后的数组元素
        }
        
        /**
         * 显示数组所有元素
         *
         * @param array
         *            要显示的数组
         */
        public void showArray(int[] array) {
                for (int i : array) {// foreach格式遍历数组
                        System.out.print(" >" + i);// 输出每个数组元素值
                }
                System.out.println();
        }
}

---

作者: 小海    时间: 2014-3-21 21:13
说明文档就是注释吧，放在函数之上应该就是方便于阅读吧

---

作者: 老金vic    时间: 2014-3-22 23:44
文档注释主要是为了阅读性，因为将来别人有可能要调用你的程序，要注释好让别人理解，在对于有需要注解每一行的之后添加，而不是你说的一定要在函数之上。

---

作者: 孟茹    时间: 2014-3-23 10:01
文档不一定规定在函数之上，但是写在函数之前就会更方便阅读，也为了以后便于维护和修改，有的程序员写了代码就走了，难道要后续的程序员看完整段代码再明白是干什么的么？还有难道你看别人代码时，会先从中间开始看么？
没有文档就写代码，就跟没有设计图就施工一样。有多少人会住这样建出来的房子，就有多少客户会用这样写出来的程序。

---

欢迎光临 黑马程序员技术交流社区 (http://bbs.itheima.com/)

黑马程序员IT技术论坛 X3.2