A股上市公司传智教育(股票代码 003032)旗下技术交流社区北京昌平校区

 找回密码
 加入黑马

QQ登录

只需一步,快速开始

© 梦幻 中级黑马   /  2014-3-21 20:44  /  1276 人查看  /  3 人回复  /   0 人收藏 转载请遵从CC协议 禁止商业使用本文

本帖最后由 梦幻 于 2014-3-24 14:51 编辑

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

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();
        }
}

评分

参与人数 1技术分 +1 收起 理由
朱神必 + 1

查看全部评分

3 个回复

倒序浏览
说明文档就是注释吧,放在函数之上应该就是方便于阅读吧
回复 使用道具 举报
文档注释主要是为了阅读性,因为将来别人有可能要调用你的程序,要注释好让别人理解,在对于有需要注解每一行的之后添加,而不是你说的一定要在函数之上。
回复 使用道具 举报
文档不一定规定在函数之上,但是写在函数之前就会更方便阅读,也为了以后便于维护和修改,有的程序员写了代码就走了,难道要后续的程序员看完整段代码再明白是干什么的么?还有难道你看别人代码时,会先从中间开始看么?
没有文档就写代码,就跟没有设计图就施工一样。有多少人会住这样建出来的房子,就有多少客户会用这样写出来的程序。
回复 使用道具 举报
您需要登录后才可以回帖 登录 | 加入黑马