improve comments

Author: oldratlee

docs/java.md

@@ -31,7 +31,7 @@
 用于快速排查`Java`的`CPU`性能问题(`top us`值过高)，自动查出运行的`Java`进程中消耗`CPU`多的线程，并打印出其线程栈，从而确定导致性能问题的方法调用。  
 目前只支持`Linux`。原因是`Mac`、`Windows`的`ps`命令不支持列出线程线程，更多信息参见[#33](https://github.com/oldratlee/useful-scripts/issues/33)，欢迎提供解法。
 
-PS，如何操作可以参见[@bluedavy](http://weibo.com/bluedavy)的《分布式Java应用》的【5.1.1 cpu消耗分析】一节，说得很详细：
+PS，如何操作可以参见[@bluedavy](http://weibo.com/bluedavy)的[《分布式Java应用》](https://book.douban.com/subject/4848587/)的【5.1.1 cpu消耗分析】一节，说得很详细：
 
 1. `top`命令找出有问题`Java`进程及线程`id`：
     1. 开启线程显示模式（`top -H`，或是打开`top`后按`H`）
@@ -42,7 +42,7 @@ PS，如何操作可以参见[@bluedavy](http://weibo.com/bluedavy)的《分布
 1. 查找十六进制的线程`id`（可以用`vim`的查找功能`/0x1234`，或是`grep 0x1234 -A 20`）
 1. 查看对应的线程栈，以分析问题
 
-查问题时，会要多次这样操作以确定问题，上面过程**太繁琐太慢了**。
+查问题时，会要多次上面的操作以分析确定问题，这个过程**太繁琐太慢了**。
 
 ### 用法
 
@@ -139,7 +139,9 @@ $ show-busy-java-threads
     at com.xxx.foo.services.common.utils.AliTimer$2.run(AliTimer.java:128)
     at java.util.concurrent.ThreadPoolExecutor$Worker.runTask(ThreadPoolExecutor.java:886)
     at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:908)
-...
+    at java.lang.Thread.run(Thread.java:662)
+
+......
 ```
 
 上面的线程栈可以看出，`CPU`消耗最高的2个线程都在执行`java.text.DateFormat.format`，业务代码对应的方法是`shared.monitor.schedule.AppMonitorDataAvgScheduler.run`。可以基本确定：

find-in-jars

@@ -139,7 +139,7 @@ else
 fi
 
 ################################################################################
-# find logic
+# utils
 ################################################################################
 
 [ -t 1 ] && readonly is_console=true || readonly is_console=false
@@ -174,6 +174,9 @@ clearResponsiveMessage() {
     echo -n "$ec[2K$cr"
 }
 
+################################################################################
+# find logic
+################################################################################
 
 readonly jar_files="$(find "${dirs[@]}" -iname '*.jar')"
 readonly total_count="$(echo "$jar_files" | wc -l)"

parseOpts.sh

@@ -19,7 +19,7 @@
 # @author Jerry Lee (oldratlee at gmail dot com)
 
 #####################################################################
-# Utils Methods
+# Utils Funtions
 #####################################################################
 
 # NOTE: $'foo' is the escape sequence syntax of bash
@@ -50,7 +50,7 @@ _opts_convertToVarName() {
 }
 
 #####################################################################
-# Parse Methods
+# Parse Functions
 #
 # Use Globle Variable: 
 # * _OPT_INFO_LIST_INDEX : Option info, data structure.
@@ -315,7 +315,7 @@ parseOpts() {
 }
 
 #####################################################################
-# Show parsed Option Info Methods
+# Show parsed Option Info Functions
 #####################################################################
 
 _opts_showOptDescInfoList() {

show-busy-java-threads

@@ -19,8 +19,8 @@ uname | grep '^Linux' -q || {
 }
 
 # Get corrent current user name via whoami command
-#   See get https://www.lifewire.com/current-linux-user-whoami-command-3867579
-# Because if use `sudo -u` to run command, env var $USER is not rewrited/correct, just inherited from outside!
+#   See https://www.lifewire.com/current-linux-user-whoami-command-3867579
+# Because if run command by `sudo -u`, env var $USER is not rewrited/correct, just inherited from outside!
 readonly USER="`whoami`"
 
 usage() {
@@ -54,6 +54,10 @@ EOF
     exit $1
 }
 
+################################################################################
+# parse options
+################################################################################
+
 readonly ARGS=`getopt -n "$PROG" -a -o p:c:a:s:Fmlh -l count:,pid:,append-file:,jstack-path:,force,mix-native-frames,lock-info,help -- "$@"`
 [ $? -ne 0 ] && usage 1
 eval set -- "${ARGS}"
@@ -103,19 +107,20 @@ update_delay=${1:-0}
 [ -z "$1" ] && update_count=1 || update_count=${2:-0}
 [ $update_count -lt 0 ] && update_count=0
 
+################################################################################
+# utils funtions
+################################################################################
+
 # NOTE: $'foo' is the escape sequence syntax of bash
 readonly ec=$'\033' # escape char
 readonly eend=$'\033[0m' # escape end
 
 colorPrint() {
     local color=$1
     shift
-    if [ -t 1 ] ; then
-        # if stdout is console, turn on color output.
-        echo "$ec[1;${color}m$@$eend"
-    else
-        echo "$@"
-    fi
+
+    # if stdout is console, turn on color output.
+    [ -t 1 ] && echo "$ec[1;${color}m$@$eend" || echo "$@"
 
     [ -n "$append_file" ] && echo "$@" >> "$append_file"
 }
@@ -142,13 +147,16 @@ normalPrint() {
     [ -n "$append_file" ] && echo "$@" >> "$append_file"
 }
 
+################################################################################
+# check the existence of jstack command!
+################################################################################
+
 if [ -n "$jstack_path" ]; then
     [ ! -x "$jstack_path" ] && {
         redPrint "Error: $jstack_path is NOT found/executalbe!" 1>&2
         exit 1
     }
 elif which jstack &> /dev/null; then
-    # Check the existence of jstack command!
     jstack_path="`which jstack`"
 else
     [ -z "$JAVA_HOME" ] && {
@@ -166,6 +174,10 @@ else
     jstack_path="$JAVA_HOME/bin/jstack"
 fi
 
+################################################################################
+# biz logic
+################################################################################
+
 readonly uuid=`date +%s`_${RANDOM}_$$
 
 cleanupWhenExit() {
@@ -192,14 +204,14 @@ printStackOfThreads() {
                 elif [ $UID == 0 ]; then
                     sudo -u "${user}" "$jstack_path" ${force} $mix_native_frames $more_lock_info ${pid} > ${jstackFile}
                 else
-                    redPrint "[$counter] Fail to jstack Busy(${pcpu}%) thread(${threadId}/${threadId0x}) stack of java process(${pid}) under user(${user})."
+                    redPrint "[$counter] Fail to jstack busy(${pcpu}%) thread(${threadId}/${threadId0x}) stack of java process(${pid}) under user(${user})."
                     redPrint "User of java process($user) is not current user($USER), need sudo to run again:"
                     yellowPrint "    sudo ${COMMAND_LINE[@]}"
                     normalPrint
                     continue
                 fi
             } || {
-                redPrint "[$counter] Fail to jstack Busy(${pcpu}%) thread(${threadId}/${threadId0x}) stack of java process(${pid}) under user(${user})."
+                redPrint "[$counter] Fail to jstack busy(${pcpu}%) thread(${threadId}/${threadId0x}) stack of java process(${pid}) under user(${user})."
                 normalPrint
                 rm ${jstackFile}
                 continue

test-cases/parseOpts-test.sh

@@ -6,7 +6,7 @@ BASE=`dirname $0`
 
 
 #################################################
-# Utils Methods
+# Utils Functions
 #################################################
 
 # NOTE: $'foo' is the escape sequence syntax of bash