CS-Notes/notes/编写可读代码的艺术.md

• ?? 1 ?? ???????????
• ?? 2 ?? ?????????????
• ?? 3 ?? ??????????????
• ?? 4 ?? ??????????
• ?? 5 ?? ??§Õ???
• ?? 6 ?? ??¦Á?§Õ???
• ?? 7 ?? ??????????????
• ?? 8 ?? ????????
• ?? 9 ?? ??????????
• ?? 10 ?? ???????
• ?? 11 ?? ???????????
• ?? 12 ?? ????????????????
• ?? 13 ?? ?????????

?? 1 ?? ???????????

????§Ü?????????????????????????????????????????????????????????????????????????????????§¹???

??????????????????????????????????????????????????????????????????????

???????????????§¹???????????????????????????¦Ë??

?? 2 ?? ?????????????

?§»????§Ò??????????

????	?????????
send	deliver??dispatch??announce??distribute??route
find	search??extract??locate??recover
start	launch??create??begin??open
make	create??set up??build??generate??compose??add??new

??? i??j??k ?????????????????????????????????§Ò??????????????????? user_i??member_i?????????????????????????§Ò???????????????????????

?????????????????????????????§Ò??????????????????????????????????????????????????????????????????????????§»???????

?? 3 ?? ??????????????

??????????????¡À?????????????§Ü¦Í???????????????????????‰^

?? min??max ?????????¦¶??

?? first??last ???????????????¦¶??begin??end ???????????????¦¶???? end ??????¦Â????

???????????????? is??can??should??has ??????

?? 4 ?? ??????????

???????§Ü?????

?????????????

int a = 1;   // ???
int b = 11;  // ???
int c = 111; // ???

?????????????????? html ??????????????????¨²???? html ?§Ö????????

?????????????????????

?? 5 ?? ??§Õ???

????????????????????????????????????????????????????????§»???????????????????§Õ???????????????????????????????????????§»??? getter ?? setter ?????????§»????§Õ?????????????????þŸ

???????????????????????????????????????????§Õ????

??????????????????????????????????????????????????????

????????????§»?????????

?? TODO ????????

???	?¡Â?
TODO	????
FIXME	?????
HACH	??????????
XXX	¦²??????????????????

?? 6 ?? ??¦Á?§Õ???

????????????

// The first String is student's name
// The Second Integer is student's score
Map<String, Integer> scoreMap = new HashMap<>();

// Student' name -> Student's score
Map<String, Integer> scoreMap = new HashMap<>();

?????????????????

//...
// Example: add(1, 2), return 3
int add(int x, int y) {
    return x + y;
}

???????????????§Ø?????????????????

int a = 1;
int b = 2;
int num = add(\* x = *\ a, \* y = *\ b);

???????????????????????????????????????????????

?? 7 ?? ??????????????

?????????§µ?????????????????????????????????????????

if(len < 10)
if(10 > len)

if / else ??????????????????????? ????????? ????????????????

if(a == b) {
    // ?????
} else{
    // ?????
}

??????????????????? ? : ???????????????????????????¨°??? if / else??

do / while ????????????—¨???????????????????§»?????????????? while ?????µµ

????????? goto ?????? goto ?????????????????????? goto ???????????????????????? goto??

??????????§µ????§» return ?????????????????????

?? 8 ?? ????????

???????????????????????§»??????????????????

if line.split(':')[0].strip() == "root":
    ...

username = line.split(':')[0].strip()
if username == "root":
    ...

????????????§»?????????

if(!a && !b) {
    ...
}

if(a || b) {
    ...
}

?? 9 ?? ??????????

????????????????????????? break ???? return ????????????????????¨¢?

boolean done = false;
while(/* condition */ && !done) {
    ...
    if(...) {
        done = true;
        continue;
    }
}

while(/* condition */) {
    ...
    if(...) {
        break;
    }
}

??§³?????????????????§³????????¦Ë??????????????????

JavaScript ??????????§³??????????????? submit_form ???????????submitted ????????????????????¦±??????????? submitted ??????????????????? submitted ????????????§µ??????????????????¦¶??

submitted = false;
var submit_form = function(form_name) {
    if(submitted) {
        return;
    }
    submitted = true;
};

var submit_form = (function() {
    var submitted = false;
    return function(form_name) {
        if(submitted) {
            return;
        }
        submitted = true;
    }
}());  // () ?????????????????????

JavaScript ??????? var ????????????????????????????????????????????????????? var ????????????

?????????¦Ë?????????????¦Ë???????

???????

?????????????????????????¦²?

<input type = "text" id = "input1" value = "a">
<input type = "text" id = "input2" value = "b">
<input type = "text" id = "input3" value = "">
<input type = "text" id = "input4" value = "d">

?????????????????????????????????? input ????§µ????????????

var setFirstEmptyInput = function(new_alue) {
    var found = false;
    var i = 1;
    var elem = document.getElementById('input' + i);
    while(elem != null) {
        if(elem.value === '') {
            found = true;
            break;
        }
        i++;
        elem = document.getElementById('input' + i);
    }
    if(found) elem.value = new_value;
    return elem;
}

?????????????????

• found ?????????
• elem ?????????
• ?????? for ??????? while ?????

var setFirstEmptyInput = function(new_value) {
    for(var i = 1; true; i++) {
        var elem = document.getElementById('input' + i);
        if(elem === null) {
            return null;
        }
        if(elem.value === '') {
            elem.value = new_value;
            return elem;
        }
    }
};

?? 10 ?? ???????

??????????????????§³?????????§»?????????????????

?????????????????????????????????????????????????????????????????????????§³?

??????????

int findClostElement(int[] arr) {
    int clostIdx;
    int clostDist = Interger.MAX_VALUE;
    for(int i = 0; i < arr.length; i++) {
        int x = ...;
        int y = ...;
        int z = ...;
        int value = x * y * z;
        int dist = Math.sqrt(Math.pow(value, 2), Math.pow(arr[i], 2));
        if(dist < clostDist) {
            clostIdx = i;
            clostDist = value;
        }
    }
    return clostIdx;
}

??????????????????????????????????????????????????????????§³?????????????????????????????????????§³???????????????????????§µ???????????§Ó?????????????????????????

public int findClostElement(int[] arr) {
    int clostIdx;
    int clostDist = Interger.MAX_VALUE;
    for(int i = 0; i < arr.length; i++) {
        int dist = computDist(arr, i);
        if(dist < clostDist) {
            clostIdx = i;
            clostDist = value;
        }
    }
    return clostIdx;
}

?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

?????????????§³?????????

?? 11 ?? ???????????

??????????????????????????????????

??????????§Ô???????????????????????????????????????????????????

?? 12 ?? ????????????????

?????????????§Õ??????????????¦Á?????????§Õ????????????????????????

?? 13 ?? ?????????

????????????????????§Ü??<3F>£??????????????????????????????

????????????