You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@dubbo.apache.org by "carryxyh (GitHub)" <gi...@apache.org> on 2018/12/04 09:00:47 UTC
[GitHub] [incubator-dubbo] carryxyh opened issue #2884: We need more
code comments
目前我们的代码中，注释的覆盖率非常低，这对于初入dubbo的开发者是不友好的，我们应该开始着手解决这个问题。非常欢迎开发者为我们提交PR来完善注释。
At present, the coverage of comments in our code is very low, which is not friendly to developers who are new to dubbo. We should start to solve this problem. Developers are welcome to submit PRs for us to complete the comments.
:)
[ Full content available at: https://github.com/apache/incubator-dubbo/issues/2884 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org
[GitHub] [incubator-dubbo] oldratlee commented on issue #2884: We
need more code comments
Posted by "oldratlee (GitHub)" <gi...@apache.org>.
comment coverage report of 1f751a602654f52d1ea86488a66d56c2a8faced6 generated by below script: @ralf0131
\# **excluded the licence comments** at file beginning.
NO. | module | product code | test code
--- | ------ | ------------ | ---------
1 | dubbo-demo-api | 0.0% (0/3) | -
2 | dubbo-serialization-fastjson | 0.0% (0/179) | -
3 | dubbo-serialization-fst | 0.0% (0/192) | -
4 | dubbo-serialization-protostuff | 1.0% (3/305) | -
5 | dubbo-rpc-http | 1.6% (3/184) | 4.3% (9/199)
6 | dubbo-registry-redis | 1.7% (10/572) | 0.0% (0/80)
7 | dubbo-rpc-redis | 1.9% (3/151) | 1.7% (3/175)
8 | dubbo-remoting-zookeeper | 2.4% (12/479) | 0.0% (0/264)
9 | dubbo-rpc-webservice | 2.4% (3/122) | 12.8% (16/109)
10 | dubbo-registry-zookeeper | 2.9% (8/268) | 3.3% (4/117)
11 | dubbo-serialization-jdk | 3.1% (12/376) | -
12 | dubbo-rpc-memcached | 3.2% (3/92) | 0.0% (0/2)
13 | dubbo-rpc-hessian | 3.4% (9/257) | 3.8% (9/225)
14 | dubbo-serialization-hessian2 | 3.7% (6/157) | -
15 | dubbo-registry-multicast | 3.8% (15/382) | 23.3% (44/145)
16 | dubbo-remoting-mina | 4.0% (23/549) | 20.2% (34/134)
17 | dubbo-container-log4j | 4.2% (3/69) | 21.4% (3/11)
18 | dubbo-monitor-default | 4.6% (17/354) | 1.9% (6/313)
19 | dubbo-remoting-netty | 4.9% (52/1007) | 11.1% (68/544)
20 | dubbo-remoting-grizzly | 5.1% (27/506) | -
21 | dubbo-rpc-dubbo | 6.0% (173/2716) | 5.3% (111/1969)
22 | dubbo-rpc-rest | 7.3% (58/738) | 3.6% (11/294)
23 | dubbo-rpc-thrift | 7.5% (93/1149) | 8.2% (677/7596)
24 | dubbo-serialization-kryo | 7.5% (34/422) | -
25 | dubbo-container-spring | 7.9% (3/35) | 18.8% (3/13)
26 | dubbo-filter-validation | 8.6% (33/349) | 0.0% (0/158)
27 | dubbo-rpc-injvm | 10.1% (15/133) | 6.1% (12/185)
28 | dubbo-compatible | 10.3% (245/2136) | 0.7% (11/1545)
29 | dubbo-rpc-rmi | 10.6% (13/110) | 34.2% (80/154)
30 | dubbo-registry-default | 11.4% (23/178) | 10.1% (172/1529)
31 | dubbo-remoting-p2p | 12.1% (117/852) | 0.0% (0/152)
32 | dubbo-remoting-netty4 | 12.2% (168/1213) | 7.6% (20/242)
33 | dubbo-container-api | 13.5% (12/77) | -
34 | dubbo-cluster | 14.1% (408/2482) | 7.6% (278/3387)
35 | dubbo-registry-api | 14.9% (350/1996) | 14.0% (129/791)
36 | dubbo-config-api | 16.1% (762/3962) | 4.9% (212/4103)
37 | dubbo-filter-cache | 16.8% (96/477) | 0.0% (0/196)
38 | dubbo-qos | 17.3% (289/1384) | 0.0% (0/706)
39 | dubbo-common | 18.6% (3414/14930) | 1.8% (159/8688)
40 | dubbo-monitor-api | 19.1% (52/220) | 2.8% (6/206)
41 | dubbo-container-logback | 19.4% (14/58) | 13.6% (3/19)
42 | dubbo-config-spring | 19.6% (683/2807) | 7.6% (238/2893)
43 | dubbo-remoting-api | 20.3% (1545/6054) | 6.0% (255/3979)
44 | dubbo-remoting-http | 20.5% (79/306) | 0.0% (0/58)
45 | dubbo-demo-provider | 20.8% (5/19) | -
46 | dubbo-test-spring3 | 21.1% (20/75) | -
47 | dubbo-rpc-api | 21.2% (1036/3851) | 4.7% (76/1551)
48 | dubbo-demo-consumer | 21.7% (5/18) | -
49 | dubbo-metrics-api | 40.5% (405/595) | 0.0% (0/127)
50 | dubbo-serialization-api | 71.6% (194/77) | -
--------------
`comment-coverage-report.sh`:
https://gist.github.com/oldratlee/6d02a849b8b84a9aba26be7ee65f5560
[ Full content available at: https://github.com/apache/incubator-dubbo/issues/2884 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org
[GitHub] [incubator-dubbo] oldratlee commented on issue #2884: We
need more code comments
Posted by "oldratlee (GitHub)" <gi...@apache.org>.
> @ralf0131
> @oldratlee Can you break it down by modules? We can start from the lowest.
comment coverage data per module sorted by product code:
module | product code | test code
------- | --------- | ----------
dubbo-registry | 18.2% | 19.2%
dubbo-monitor | 25.3% | 17.1%
dubbo-config | 25.8% | 24.5%
dubbo-common | 25.9% | 23.2%
dubbo-rpc | 27.4% | 18.3%
dubbo-remoting | 29.8% | 22.4%
dubbo-container | 31.5% | 55.3%
dubbo-plugin | 34.3% | 32.6%
dubbo-filter | 34.7% | 32.5%
dubbo-serialization | 35.2% | 16.8%
dubbo-cluster | 35.5% | 19.4%
dubbo-compatible | 40.3% | 23.8%
dubbo-metrics | 50.8% | 19.9%
dubbo-test | 51.5% | -
dubbo-demo | 62.7% | -
PS：
If needed, I can write a script to generate above table.
----------------------
Below is the quick-hack script to show coverage data per module:
```bash
$ for d in `find -mindepth 1 -maxdepth 1 -type d -name 'dubbo*'`; do (
echo
echo "===================================="
echo $d
echo "===================================="
cd $d
ohcount **/src/main/; ohcount **/src/test/
)
done
......
====================================
./dubbo-cluster
====================================
Examining 67 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 62 2544 1400 35.5% 490 4434
---------------- ----- --------- --------- --------- --------- ---------
Total 62 2544 1400 35.5% 490 4434
Examining 38 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 34 3421 822 19.4% 706 4949
xml 1 13 14 51.9% 2 29
---------------- ----- --------- --------- --------- --------- ---------
Total 35 3434 836 19.6% 708 4978
====================================
./dubbo-common
====================================
Examining 121 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 115 15045 5248 25.9% 2610 22903
---------------- ----- --------- --------- --------- --------- ---------
Total 115 15045 5248 25.9% 2610 22903
Examining 183 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 158 8846 2671 23.2% 1899 13416
xml 1 14 18 56.2% 0 32
---------------- ----- --------- --------- --------- --------- ---------
Total 159 8860 2689 23.3% 1899 13448
====================================
./dubbo-compatible
====================================
Examining 78 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 78 2214 1493 40.3% 915 4622
---------------- ----- --------- --------- --------- --------- ---------
Total 78 2214 1493 40.3% 915 4622
Examining 31 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 30 1575 491 23.8% 369 2435
---------------- ----- --------- --------- --------- --------- ---------
Total 30 1575 491 23.8% 369 2435
====================================
./dubbo-config
====================================
Examining 64 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 58 6827 2373 25.8% 1826 11026
xmlschema 2 2563 0 0.0% 67 2630
---------------- ----- --------- --------- --------- --------- ---------
Total 60 9390 2373 20.2% 1893 13656
Examining 183 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 116 7112 2306 24.5% 1697 11115
xml 45 608 719 54.2% 311 1638
---------------- ----- --------- --------- --------- --------- ---------
Total 161 7720 3025 28.2% 2008 12753
====================================
./dubbo-container
====================================
Examining 14 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 5 244 112 31.5% 55 411
shell 5 240 6 2.4% 26 272
bat 1 22 1 4.3% 6 29
---------------- ----- --------- --------- --------- --------- ---------
Total 11 506 119 19.0% 87 712
Examining 5 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 3 46 57 55.3% 18 121
xml 2 19 28 59.6% 6 53
---------------- ----- --------- --------- --------- --------- ---------
Total 5 65 85 56.7% 24 174
====================================
./dubbo-demo
====================================
Examining 10 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 4 44 74 62.7% 15 133
xml 2 22 38 63.3% 14 74
---------------- ----- --------- --------- --------- --------- ---------
Total 6 66 112 62.9% 29 207
zsh: no matches found: **/src/test/
====================================
./dubbo-dependencies-bom
====================================
zsh: no matches found: **/src/main/
zsh: no matches found: **/src/test/
====================================
./dubbo-distribution
====================================
zsh: no matches found: **/src/main/
zsh: no matches found: **/src/test/
====================================
./dubbo-filter
====================================
Examining 24 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 20 846 449 34.7% 182 1477
---------------- ----- --------- --------- --------- --------- ---------
Total 20 846 449 34.7% 182 1477
Examining 11 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 11 365 176 32.5% 91 632
---------------- ----- --------- --------- --------- --------- ---------
Total 11 365 176 32.5% 91 632
====================================
./dubbo-metrics
====================================
Examining 14 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 14 609 629 50.8% 222 1460
---------------- ----- --------- --------- --------- --------- ---------
Total 14 609 629 50.8% 222 1460
Examining 2 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 2 129 32 19.9% 30 191
---------------- ----- --------- --------- --------- --------- ---------
Total 2 129 32 19.9% 30 191
====================================
./dubbo-monitor
====================================
Examining 10 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 8 582 197 25.3% 123 902
---------------- ----- --------- --------- --------- --------- ---------
Total 8 582 197 25.3% 123 902
Examining 6 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 6 525 108 17.1% 98 731
---------------- ----- --------- --------- --------- --------- ---------
Total 6 525 108 17.1% 98 731
====================================
./dubbo-plugin
====================================
Examining 30 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 28 1412 737 34.3% 371 2520
---------------- ----- --------- --------- --------- --------- ---------
Total 28 1412 737 34.3% 371 2520
Examining 24 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 22 728 352 32.6% 110 1190
---------------- ----- --------- --------- --------- --------- ---------
Total 22 728 352 32.6% 110 1190
====================================
./dubbo-registry
====================================
Examining 28 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 22 3418 758 18.2% 434 4610
---------------- ----- --------- --------- --------- --------- ---------
Total 22 3418 758 18.2% 434 4610
Examining 20 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 18 2680 637 19.2% 586 3903
xml 2 33 35 51.5% 4 72
---------------- ----- --------- --------- --------- --------- ---------
Total 20 2713 672 19.9% 590 3975
====================================
./dubbo-remoting
====================================
Examining 180 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 169 11153 4727 29.8% 2527 18407
---------------- ----- --------- --------- --------- --------- ---------
Total 169 11153 4727 29.8% 2527 18407
Examining 77 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 75 5448 1577 22.4% 1096 8121
xml 2 27 35 56.5% 4 66
---------------- ----- --------- --------- --------- --------- ---------
Total 77 5475 1612 22.7% 1100 8187
......
[ Full content available at: https://github.com/apache/incubator-dubbo/issues/2884 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org
[GitHub] [incubator-dubbo] oldratlee commented on issue #2884: We
need more code comments
Posted by "oldratlee (GitHub)" <gi...@apache.org>.
> @ralf0131
> @oldratlee Can you break it down by modules? We can start from the lowest.
comment coverage data per module sorted by product code:
module | product code | test code
------- | --------- | ----------
dubbo-registry | 18.2% | 19.2%
dubbo-monitor | 25.3% | 17.1%
dubbo-config | 25.8% | 24.5%
dubbo-common | 25.9% | 23.2%
dubbo-rpc | 27.4% | 18.3%
dubbo-remoting | 29.8% | 22.4%
dubbo-container | 31.5% | 55.3%
dubbo-plugin | 34.3% | 32.6%
dubbo-filter | 34.7% | 32.5%
dubbo-serialization | 35.2% | 16.8%
dubbo-cluster | 35.5% | 19.4%
dubbo-compatible | 40.3% | 23.8%
dubbo-metrics | 50.8% | 19.9%
dubbo-test | 51.5% | -
dubbo-demo | 62.7% | -
PS：
If needed, I can write a script to generate above table.
----------------------
Below is the quick-hack script to show coverage data per module:
```bash
$ for d in `find -mindepth 1 -maxdepth 1 -type d -name 'dubbo*'`; do (
echo
echo "===================================="
echo $d
echo "===================================="
cd $d
ohcount **/src/main/; ohcount **/src/test/
)
done
......
====================================
./dubbo-cluster
====================================
Examining 67 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 62 2544 1400 35.5% 490 4434
---------------- ----- --------- --------- --------- --------- ---------
Total 62 2544 1400 35.5% 490 4434
Examining 38 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 34 3421 822 19.4% 706 4949
xml 1 13 14 51.9% 2 29
---------------- ----- --------- --------- --------- --------- ---------
Total 35 3434 836 19.6% 708 4978
====================================
./dubbo-common
====================================
Examining 121 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 115 15045 5248 25.9% 2610 22903
---------------- ----- --------- --------- --------- --------- ---------
Total 115 15045 5248 25.9% 2610 22903
Examining 183 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 158 8846 2671 23.2% 1899 13416
xml 1 14 18 56.2% 0 32
---------------- ----- --------- --------- --------- --------- ---------
Total 159 8860 2689 23.3% 1899 13448
......
[ Full content available at: https://github.com/apache/incubator-dubbo/issues/2884 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org
[GitHub] [incubator-dubbo] oldratlee commented on issue #2884: We
need more code comments
Posted by "oldratlee (GitHub)" <gi...@apache.org>.
comment coverage report generated by below script:
module | product code | test code
------ | ------------ | ---------
dubbo-registry-redis | 6.8% | 16.5%
dubbo-registry-multicast | 10.9% | 34.1%
dubbo-rpc-redis | 11.1% | 16.5%
dubbo-registry-zookeeper | 12.9% | 14.5%
dubbo-rpc-webservice | 13.4% | 41.5%
dubbo-monitor-default | 15.4% | 18.1%
dubbo-rpc-http | 15.8% | 22.0%
dubbo-remoting-netty | 16.2% | 34.4%
dubbo-rpc-dubbo | 16.9% | 21.4%
dubbo-rpc-memcached | 17.0% | 84.2%
dubbo-remoting-mina | 17.7% | 48.1%
dubbo-remoting-grizzly | 19.4% | -
dubbo-rpc-thrift | 20.6% | 11.3%
dubbo-serialization-fastjson | 20.9% | -
dubbo-remoting-netty4 | 21.1% | 37.2%
dubbo-container-log4j | 21.3% | 61.3%
dubbo-config-api | 21.9% | 22.9%
dubbo-rpc-hessian | 21.9% | 20.0%
dubbo-registry-api | 22.2% | 20.8%
dubbo-registry-default | 23.4% | 17.0%
dubbo-serialization-protostuff | 24.1% | -
dubbo-serialization-fst | 24.6% | -
dubbo-common | 25.9% | 23.2%
dubbo-remoting-zookeeper | 26.0% | 22.9%
dubbo-rpc-rest | 28.4% | 33.8%
dubbo-rpc-rmi | 28.7% | 52.4%
dubbo-serialization-jdk | 28.8% | -
dubbo-filter-validation | 28.9% | 32.9%
dubbo-serialization-hessian2 | 30.3% | -
dubbo-config-spring | 30.7% | 26.7%
dubbo-serialization-kryo | 31.0% | -
dubbo-rpc-injvm | 31.7% | 39.2%
dubbo-remoting-api | 33.2% | 17.4%
dubbo-remoting-p2p | 33.4% | 23.6%
dubbo-container-logback | 33.7% | 48.7%
dubbo-qos | 34.3% | 32.6%
dubbo-container-spring | 34.5% | 57.6%
dubbo-cluster | 35.5% | 19.4%
dubbo-container-api | 35.8% | -
dubbo-rpc-api | 36.0% | 31.0%
dubbo-monitor-api | 37.0% | 15.4%
dubbo-filter-cache | 38.3% | 32.2%
dubbo-compatible | 40.3% | 23.8%
dubbo-remoting-http | 47.4% | 34.8%
dubbo-metrics-api | 50.8% | 19.9%
dubbo-test-spring3 | 51.5% | -
dubbo-demo-consumer | 52.5% | -
dubbo-demo-provider | 63.8% | -
dubbo-serialization-api | 79.1% | -
dubbo-demo-api | 80.0% | -
--------------
`comment-coverage-report.sh`:
```bash
#!/bin/bash
# comment-coverage-report.sh
# generate comment coverage report, markdown table format
#
# NOTE:
# 1. run at project root dir
# 2. install ohcount: https://github.com/blackducksw/ohcount
# if you use mac install by brew: brew install ohcount
set -euo pipefail
getCommentCoverage() {
local dir="$1"
local comment_coverage="$(ohcount "$dir" | awk '/^java /{print $5}')"
echo "${comment_coverage:--}"
}
listModulePoms() {
find . -name pom.xml
}
getCommentCoverageOfModule() {
local pom
while read pom ; do
local module_dir="$(dirname "$pom")"
local module_name="$(basename "$module_dir")"
local module_product_code_dir="$module_dir/src/main/java"
local module_test_code_dir="$module_dir/src/test/java"
# no product code dir, skip
[ ! -d "$module_product_code_dir" ] && continue
# output comment coverage table line of module
echo "$module_name | $(getCommentCoverage "$module_product_code_dir") | $(getCommentCoverage "$module_test_code_dir")"
done
}
genCommentCoverageReport() {
# output table header
echo "module | product code | test code"
echo "------ | ------------ | ---------"
# output table body
listModulePoms | getCommentCoverageOfModule | sort '-t|' -n -k2
}
genCommentCoverageReport
```
[ Full content available at: https://github.com/apache/incubator-dubbo/issues/2884 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org
[GitHub] [incubator-dubbo] oldratlee commented on issue #2884: We
need more code comments
Posted by "oldratlee (GitHub)" <gi...@apache.org>.
> @ralf0131
> @oldratlee Can you break it down by modules? We can start from the lowest.
comment coverage data per module sorted by product code:
module | product code | test code
------- | --------- | ----------
dubbo-registry | 18.2% | 19.2%
dubbo-monitor | 25.3% | 17.1%
dubbo-config | 25.8% | 24.5%
dubbo-common | 25.9% | 23.2%
dubbo-rpc | 27.4% | 18.3%
dubbo-remoting | 29.8% | 22.4%
dubbo-container | 31.5% | 55.3%
dubbo-plugin | 34.3% | 32.6%
dubbo-filter | 34.7% | 32.5%
dubbo-serialization | 35.2% | 16.8%
dubbo-cluster | 35.5% | 19.4%
dubbo-compatible | 40.3% | 23.8%
dubbo-metrics | 50.8% | 19.9%
dubbo-test | 51.5% | -
dubbo-demo | 62.7% | -
PS：
If needed, I can write a script to generate above table.
----------------------
Below is the quick-hack script to show coverage data per module:
```bash
$ for d in `find -mindepth 1 -maxdepth 1 -type d -name 'dubbo*'`; do (
echo
echo "===================================="
echo $d
echo "===================================="
cd $d
ohcount **/src/main/; ohcount **/src/test/
)
done
......
====================================
./dubbo-cluster
====================================
Examining 67 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 62 2544 1400 35.5% 490 4434
---------------- ----- --------- --------- --------- --------- ---------
Total 62 2544 1400 35.5% 490 4434
Examining 38 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 34 3421 822 19.4% 706 4949
xml 1 13 14 51.9% 2 29
---------------- ----- --------- --------- --------- --------- ---------
Total 35 3434 836 19.6% 708 4978
====================================
./dubbo-common
====================================
Examining 121 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 115 15045 5248 25.9% 2610 22903
---------------- ----- --------- --------- --------- --------- ---------
Total 115 15045 5248 25.9% 2610 22903
Examining 183 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 158 8846 2671 23.2% 1899 13416
xml 1 14 18 56.2% 0 32
---------------- ----- --------- --------- --------- --------- ---------
Total 159 8860 2689 23.3% 1899 13448
====================================
./dubbo-compatible
====================================
Examining 78 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 78 2214 1493 40.3% 915 4622
---------------- ----- --------- --------- --------- --------- ---------
Total 78 2214 1493 40.3% 915 4622
Examining 31 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 30 1575 491 23.8% 369 2435
---------------- ----- --------- --------- --------- --------- ---------
Total 30 1575 491 23.8% 369 2435
......
[ Full content available at: https://github.com/apache/incubator-dubbo/issues/2884 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org
[GitHub] [incubator-dubbo] chenlushun commented on issue #2884: We
need more code comments
Posted by "chenlushun (GitHub)" <gi...@apache.org>.
I recommend that when you write comments, you change lines in the right place so that it's easy to read. The following comments needs to slide.
```java
/**
* Register data, such as : provider service, consumer address, route rule, override rule and other data.
* <p>
* Registering is required to support the contract:<br>
* 1. When the URL sets the check=false parameter. When the registration fails, the exception is not thrown and retried in the background. Otherwise, the exception will be thrown.<br>
* 2. When URL sets the dynamic=false parameter, it needs to be stored persistently, otherwise, it should be deleted automatically when the registrant has an abnormal exit.<br>
* 3. When the URL sets category=routers, it means classified storage, the default category is providers, and the data can be notified by the classified section. <br>
* 4. When the registry is restarted, network jitter, data can not be lost, including automatically deleting data from the broken line.<br>
* 5. Allow URLs which have the same URL but different parameters to coexist,they can't cover each other.<br>
*
* @param url Registration information , is not allowed to be empty, e.g: dubbo://10.20.153.10/org.apache.dubbo.foo.BarService?version=1.0.0&application=kylin
*/
void register(URL url);
```
[ Full content available at: https://github.com/apache/incubator-dubbo/issues/2884 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org
[GitHub] [incubator-dubbo] oldratlee commented on issue #2884: We
need more code comments
Posted by "oldratlee (GitHub)" <gi...@apache.org>.
> @lovepoem
> @oldratlee，can we statistics the comment coverage as test coverage in the codecov.io ?
I have not found comment coverage info in the codecov.io yet.
[ Full content available at: https://github.com/apache/incubator-dubbo/issues/2884 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org
[GitHub] [incubator-dubbo] oldratlee commented on issue #2884: We
need more code comments
Posted by "oldratlee (GitHub)" <gi...@apache.org>.
comment coverage report for https://github.com/apache/incubator-dubbo/commit/1f751a602654f52d1ea86488a66d56c2a8faced6 :
module | product code | test code
------ | ------------ | ---------
dubbo-demo-api | 0.0% (0/3) | -
dubbo-serialization-fastjson | 0.0% (0/179) | -
dubbo-serialization-fst | 0.0% (0/192) | -
dubbo-serialization-protostuff | 1.0% (3/305) | -
dubbo-rpc-http | 1.6% (3/184) | 4.3% (9/199)
dubbo-registry-redis | 1.7% (10/572) | 0.0% (0/80)
dubbo-rpc-redis | 1.9% (3/151) | 1.7% (3/175)
dubbo-remoting-zookeeper | 2.4% (12/479) | 0.0% (0/264)
dubbo-rpc-webservice | 2.4% (3/122) | 12.8% (16/109)
dubbo-registry-zookeeper | 2.9% (8/268) | 3.3% (4/117)
dubbo-serialization-jdk | 3.1% (12/376) | -
dubbo-rpc-memcached | 3.2% (3/92) | 0.0% (0/2)
dubbo-rpc-hessian | 3.4% (9/257) | 3.8% (9/225)
dubbo-serialization-hessian2 | 3.7% (6/157) | -
dubbo-registry-multicast | 3.8% (15/382) | 23.3% (44/145)
dubbo-remoting-mina | 4.0% (23/549) | 20.2% (34/134)
dubbo-container-log4j | 4.2% (3/69) | 21.4% (3/11)
dubbo-monitor-default | 4.6% (17/354) | 1.9% (6/313)
dubbo-remoting-netty | 4.9% (52/1007) | 11.1% (68/544)
dubbo-remoting-grizzly | 5.1% (27/506) | -
dubbo-rpc-dubbo | 6.0% (173/2716) | 5.3% (111/1969)
dubbo-rpc-rest | 7.3% (58/738) | 3.6% (11/294)
dubbo-rpc-thrift | 7.5% (93/1149) | 8.2% (677/7596)
dubbo-serialization-kryo | 7.5% (34/422) | -
dubbo-container-spring | 7.9% (3/35) | 18.8% (3/13)
dubbo-filter-validation | 8.6% (33/349) | 0.0% (0/158)
dubbo-rpc-injvm | 10.1% (15/133) | 6.1% (12/185)
dubbo-compatible | 10.3% (245/2136) | 0.7% (11/1545)
dubbo-rpc-rmi | 10.6% (13/110) | 34.2% (80/154)
dubbo-registry-default | 11.4% (23/178) | 10.1% (172/1529)
dubbo-remoting-p2p | 12.1% (117/852) | 0.0% (0/152)
dubbo-remoting-netty4 | 12.2% (168/1213) | 7.6% (20/242)
dubbo-container-api | 13.5% (12/77) | -
dubbo-cluster | 14.1% (408/2482) | 7.6% (278/3387)
dubbo-registry-api | 14.9% (350/1996) | 14.0% (129/791)
dubbo-config-api | 16.1% (762/3962) | 4.9% (212/4103)
dubbo-filter-cache | 16.8% (96/477) | 0.0% (0/196)
dubbo-qos | 17.3% (289/1384) | 0.0% (0/706)
dubbo-common | 18.6% (3414/14930) | 1.8% (159/8688)
dubbo-monitor-api | 19.1% (52/220) | 2.8% (6/206)
dubbo-container-logback | 19.4% (14/58) | 13.6% (3/19)
dubbo-config-spring | 19.6% (683/2807) | 7.6% (238/2893)
dubbo-remoting-api | 20.3% (1545/6054) | 6.0% (255/3979)
dubbo-remoting-http | 20.5% (79/306) | 0.0% (0/58)
dubbo-demo-provider | 20.8% (5/19) | -
dubbo-test-spring3 | 21.1% (20/75) | -
dubbo-rpc-api | 21.2% (1036/3851) | 4.7% (76/1551)
dubbo-demo-consumer | 21.7% (5/18) | -
dubbo-metrics-api | 40.5% (405/595) | 0.0% (0/127)
dubbo-serialization-api | 71.6% (194/77) | -
--------------
`comment-coverage-report.sh`:
https://gist.github.com/oldratlee/6d02a849b8b84a9aba26be7ee65f5560
[ Full content available at: https://github.com/apache/incubator-dubbo/issues/2884 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org
[GitHub] [incubator-dubbo] oldratlee commented on issue #2884: We
need more code comments
Posted by "oldratlee (GitHub)" <gi...@apache.org>.
> @ralf0131
> @oldratlee Can you break it down by modules? We can start from the lowest.
coverage data per module sorted by product code:
moduel | product code | test code
------- | --------- | ----------
dubbo-registry | 18.2% | 19.2%
dubbo-monitor | 25.3% | 17.1%
dubbo-config | 25.8% | 24.5%
dubbo-common | 25.9% | 23.2%
dubbo-rpc | 27.4% | 18.3%
dubbo-remoting | 29.8% | 22.4%
dubbo-container | 31.5% | 55.3%
dubbo-plugin | 34.3% | 32.6%
dubbo-filter | 34.7% | 32.5%
dubbo-serialization | 35.2% | 16.8%
dubbo-cluster | 35.5% | 19.4%
dubbo-compatible | 40.3% | 23.8%
dubbo-metrics | 50.8% | 19.9%
dubbo-test | 51.5% | -
dubbo-demo | 62.7% | -
----------------------
Below is the quick-hack script to show coverage data per module:
```bash
$ for d in `find -mindepth 1 -maxdepth 1 -type d -name 'dubbo*'`; do (
echo
echo "===================================="
echo $d
echo "===================================="
cd $d
ohcount **/src/main/; ohcount **/src/test/
)
done
====================================
./dubbo-all
====================================
zsh: no matches found: **/src/main/
zsh: no matches found: **/src/test/
====================================
./dubbo-bom
====================================
zsh: no matches found: **/src/main/
zsh: no matches found: **/src/test/
====================================
./dubbo-cluster
====================================
Examining 67 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 62 2544 1400 35.5% 490 4434
---------------- ----- --------- --------- --------- --------- ---------
Total 62 2544 1400 35.5% 490 4434
Examining 38 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 34 3421 822 19.4% 706 4949
xml 1 13 14 51.9% 2 29
---------------- ----- --------- --------- --------- --------- ---------
Total 35 3434 836 19.6% 708 4978
====================================
./dubbo-common
====================================
Examining 121 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 115 15045 5248 25.9% 2610 22903
---------------- ----- --------- --------- --------- --------- ---------
Total 115 15045 5248 25.9% 2610 22903
Examining 183 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 158 8846 2671 23.2% 1899 13416
xml 1 14 18 56.2% 0 32
---------------- ----- --------- --------- --------- --------- ---------
Total 159 8860 2689 23.3% 1899 13448
====================================
./dubbo-compatible
====================================
Examining 78 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 78 2214 1493 40.3% 915 4622
---------------- ----- --------- --------- --------- --------- ---------
Total 78 2214 1493 40.3% 915 4622
Examining 31 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 30 1575 491 23.8% 369 2435
---------------- ----- --------- --------- --------- --------- ---------
Total 30 1575 491 23.8% 369 2435
====================================
./dubbo-config
====================================
Examining 64 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 58 6827 2373 25.8% 1826 11026
xmlschema 2 2563 0 0.0% 67 2630
---------------- ----- --------- --------- --------- --------- ---------
Total 60 9390 2373 20.2% 1893 13656
Examining 183 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 116 7112 2306 24.5% 1697 11115
xml 45 608 719 54.2% 311 1638
---------------- ----- --------- --------- --------- --------- ---------
Total 161 7720 3025 28.2% 2008 12753
====================================
./dubbo-container
====================================
Examining 14 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 5 244 112 31.5% 55 411
shell 5 240 6 2.4% 26 272
bat 1 22 1 4.3% 6 29
---------------- ----- --------- --------- --------- --------- ---------
Total 11 506 119 19.0% 87 712
Examining 5 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 3 46 57 55.3% 18 121
xml 2 19 28 59.6% 6 53
---------------- ----- --------- --------- --------- --------- ---------
Total 5 65 85 56.7% 24 174
====================================
./dubbo-demo
====================================
Examining 10 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 4 44 74 62.7% 15 133
xml 2 22 38 63.3% 14 74
---------------- ----- --------- --------- --------- --------- ---------
Total 6 66 112 62.9% 29 207
zsh: no matches found: **/src/test/
====================================
./dubbo-dependencies-bom
====================================
zsh: no matches found: **/src/main/
zsh: no matches found: **/src/test/
====================================
./dubbo-distribution
====================================
zsh: no matches found: **/src/main/
zsh: no matches found: **/src/test/
====================================
./dubbo-filter
====================================
Examining 24 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 20 846 449 34.7% 182 1477
---------------- ----- --------- --------- --------- --------- ---------
Total 20 846 449 34.7% 182 1477
Examining 11 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 11 365 176 32.5% 91 632
---------------- ----- --------- --------- --------- --------- ---------
Total 11 365 176 32.5% 91 632
====================================
./dubbo-metrics
====================================
Examining 14 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 14 609 629 50.8% 222 1460
---------------- ----- --------- --------- --------- --------- ---------
Total 14 609 629 50.8% 222 1460
Examining 2 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 2 129 32 19.9% 30 191
---------------- ----- --------- --------- --------- --------- ---------
Total 2 129 32 19.9% 30 191
====================================
./dubbo-monitor
====================================
Examining 10 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 8 582 197 25.3% 123 902
---------------- ----- --------- --------- --------- --------- ---------
Total 8 582 197 25.3% 123 902
Examining 6 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 6 525 108 17.1% 98 731
---------------- ----- --------- --------- --------- --------- ---------
Total 6 525 108 17.1% 98 731
====================================
./dubbo-plugin
====================================
Examining 30 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 28 1412 737 34.3% 371 2520
---------------- ----- --------- --------- --------- --------- ---------
Total 28 1412 737 34.3% 371 2520
Examining 24 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 22 728 352 32.6% 110 1190
---------------- ----- --------- --------- --------- --------- ---------
Total 22 728 352 32.6% 110 1190
====================================
./dubbo-registry
====================================
Examining 28 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 22 3418 758 18.2% 434 4610
---------------- ----- --------- --------- --------- --------- ---------
Total 22 3418 758 18.2% 434 4610
Examining 20 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 18 2680 637 19.2% 586 3903
xml 2 33 35 51.5% 4 72
---------------- ----- --------- --------- --------- --------- ---------
Total 20 2713 672 19.9% 590 3975
====================================
./dubbo-remoting
====================================
Examining 180 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 169 11153 4727 29.8% 2527 18407
---------------- ----- --------- --------- --------- --------- ---------
Total 169 11153 4727 29.8% 2527 18407
Examining 77 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 75 5448 1577 22.4% 1096 8121
xml 2 27 35 56.5% 4 66
---------------- ----- --------- --------- --------- --------- ---------
Total 77 5475 1612 22.7% 1100 8187
====================================
./dubbo-rpc
====================================
Examining 159 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 139 9642 3633 27.4% 1923 15198
---------------- ----- --------- --------- --------- --------- ---------
Total 139 9642 3633 27.4% 1923 15198
Examining 130 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 122 13662 3062 18.3% 3457 20181
xml 4 58 72 55.4% 19 149
---------------- ----- --------- --------- --------- --------- ---------
Total 126 13720 3134 18.6% 3476 20330
====================================
./dubbo-serialization
====================================
Examining 50 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 44 1752 953 35.2% 490 3195
---------------- ----- --------- --------- --------- --------- ---------
Total 44 1752 953 35.2% 490 3195
Examining 36 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 34 2872 578 16.8% 756 4206
xml 1 14 14 50.0% 2 30
---------------- ----- --------- --------- --------- --------- ---------
Total 35 2886 592 17.0% 758 4236
====================================
./dubbo-test
====================================
Examining 6 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 4 79 84 51.5% 37 200
xml 2 18 33 64.7% 11 62
---------------- ----- --------- --------- --------- --------- ---------
Total 6 97 117 54.7% 48 262
zsh: no matches found: **/src/test/
```
[ Full content available at: https://github.com/apache/incubator-dubbo/issues/2884 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org
[GitHub] [incubator-dubbo] oldratlee commented on issue #2884: We
need more code comments
Posted by "oldratlee (GitHub)" <gi...@apache.org>.
comment coverage report of 1f751a602654f52d1ea86488a66d56c2a8faced6 generated by below script: @ralf0131
\# **excluded the licence comments** at file beginning.
NO. | module | product code | test code
--- | ------ | ------------ | ---------
1 | dubbo-demo-api | 0.0% (0/4) | -
2 | dubbo-serialization-fastjson | 0.0% (0/182) | -
3 | dubbo-serialization-fst | 0.0% (0/196) | -
4 | dubbo-serialization-protostuff | 1.0% (3/311) | -
5 | dubbo-rpc-http | 1.6% (3/186) | 4.3% (9/202)
6 | dubbo-registry-redis | 1.7% (10/574) | 0.0% (0/81)
7 | dubbo-rpc-redis | 1.9% (3/152) | 1.7% (3/177)
8 | dubbo-remoting-zookeeper | 2.4% (12/489) | 0.0% (0/269)
9 | dubbo-rpc-webservice | 2.4% (3/123) | 12.4% (16/113)
10 | dubbo-registry-zookeeper | 2.9% (8/270) | 3.3% (4/118)
11 | dubbo-serialization-jdk | 3.0% (12/385) | -
12 | dubbo-rpc-memcached | 3.1% (3/93) | 0.0% (0/3)
13 | dubbo-rpc-hessian | 3.3% (9/261) | 3.8% (9/228)
14 | dubbo-serialization-hessian2 | 3.6% (6/161) | -
15 | dubbo-registry-multicast | 3.8% (15/384) | 23.0% (44/147)
16 | dubbo-remoting-mina | 4.0% (23/555) | 19.5% (34/140)
17 | dubbo-container-log4j | 4.1% (3/70) | 20.0% (3/12)
18 | dubbo-monitor-default | 4.5% (17/357) | 1.9% (6/317)
19 | dubbo-remoting-netty | 4.9% (52/1016) | 10.9% (68/558)
20 | dubbo-remoting-grizzly | 5.0% (27/512) | -
21 | dubbo-rpc-dubbo | 5.9% (173/2740) | 5.3% (111/1996)
22 | dubbo-rpc-rest | 7.2% (58/753) | 3.5% (11/303)
23 | dubbo-serialization-kryo | 7.3% (34/432) | -
24 | dubbo-rpc-thrift | 7.4% (93/1162) | 8.2% (677/7612)
25 | dubbo-container-spring | 7.7% (3/36) | 17.6% (3/14)
26 | dubbo-filter-validation | 8.5% (33/356) | 0.0% (0/163)
27 | dubbo-rpc-injvm | 9.9% (15/136) | 5.9% (12/192)
28 | dubbo-compatible | 10.0% (245/2214) | 0.7% (11/1575)
29 | dubbo-rpc-rmi | 10.4% (13/112) | 33.3% (80/160)
30 | dubbo-registry-default | 11.3% (23/180) | 10.1% (172/1538)
31 | dubbo-remoting-p2p | 11.8% (117/872) | 0.0% (0/155)
32 | dubbo-remoting-netty4 | 12.1% (168/1223) | 7.4% (20/250)
33 | dubbo-container-api | 13.2% (12/79) | -
34 | dubbo-cluster | 13.8% (408/2544) | 7.5% (278/3421)
35 | dubbo-registry-api | 14.8% (350/2010) | 13.9% (129/796)
36 | dubbo-config-api | 16.1% (762/3984) | 4.8% (212/4167)
37 | dubbo-filter-cache | 16.4% (96/490) | 0.0% (0/202)
38 | dubbo-qos | 17.0% (289/1412) | 0.0% (0/728)
39 | dubbo-common | 18.5% (3414/15045) | 1.8% (159/8846)
40 | dubbo-monitor-api | 18.8% (52/225) | 2.8% (6/208)
41 | dubbo-container-logback | 19.2% (14/59) | 13.0% (3/20)
42 | dubbo-demo-provider | 19.2% (5/21) | -
43 | dubbo-config-spring | 19.4% (683/2843) | 7.5% (238/2945)
44 | dubbo-remoting-http | 19.8% (79/319) | 0.0% (0/60)
45 | dubbo-remoting-api | 20.1% (1545/6148) | 6.0% (255/4016)
46 | dubbo-test-spring3 | 20.2% (20/79) | -
47 | dubbo-demo-consumer | 20.8% (5/19) | -
48 | dubbo-rpc-api | 20.9% (1036/3924) | 4.6% (76/1591)
49 | dubbo-metrics-api | 39.9% (405/609) | 0.0% (0/129)
50 | dubbo-serialization-api | 69.5% (194/85) | -
--------------
`comment-coverage-report.sh`:
https://gist.github.com/oldratlee/6d02a849b8b84a9aba26be7ee65f5560
[ Full content available at: https://github.com/apache/incubator-dubbo/issues/2884 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org
[GitHub] [incubator-dubbo] ralf0131 commented on issue #2884: We need
more code comments
Posted by "ralf0131 (GitHub)" <gi...@apache.org>.
@khanimteyaz I've added #2921 to https://github.com/apache/incubator-dubbo/projects/2, and marked it as Done.
[ Full content available at: https://github.com/apache/incubator-dubbo/issues/2884 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org
[GitHub] [incubator-dubbo] khanimteyaz commented on issue #2884: We
need more code comments
Posted by "khanimteyaz (GitHub)" <gi...@apache.org>.
@ralf0131 I have created an issue #2935 (Creating dubbo dubbo-rpc-api java documentation) and will be on it. Claiming to work on this.
[ Full content available at: https://github.com/apache/incubator-dubbo/issues/2884 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org
[GitHub] [incubator-dubbo] carryxyh commented on issue #2884: We need
more code comments
Posted by "carryxyh (GitHub)" <gi...@apache.org>.
@khanimteyaz
We are of course willing to help you with some work, very welcome!
> some one to guide me how I can proceed further to help the community regarding the current issue
I recommend that you subscribe to our mailing list. U can subscribe the dev group and go there directly for help, send your questions, I will help you.
:)
[ Full content available at: https://github.com/apache/incubator-dubbo/issues/2884 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org
[GitHub] [incubator-dubbo] carryxyh commented on issue #2884: We need
more code comments
Posted by "carryxyh (GitHub)" <gi...@apache.org>.
Project is here
https://github.com/apache/incubator-dubbo/projects/2
[ Full content available at: https://github.com/apache/incubator-dubbo/issues/2884 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org
[GitHub] [incubator-dubbo] lovepoem commented on issue #2884: We need
more code comments
Posted by "lovepoem (GitHub)" <gi...@apache.org>.
@oldratlee，can we statistics the comment coverage as test coverage in the
codecov.io ?
Huxing Zhang <no...@github.com> 于 2018年12月4日周二 下午9:51写道：
> @oldratlee <https://github.com/oldratlee> Can you break it down by
> modules? We can start from the lowest.
>
> —
> You are receiving this because you are subscribed to this thread.
> Reply to this email directly, view it on GitHub
> <https://github.com/apache/incubator-dubbo/issues/2884#issuecomment-444106218>,
> or mute the thread
> <https://github.com/notifications/unsubscribe-auth/AAye6KS7dJ-r-XT_biBc9W7obr-FXwNMks5u1n3ygaJpZM4ZAMhZ>
> .
>
[ Full content available at: https://github.com/apache/incubator-dubbo/issues/2884 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org
[GitHub] [incubator-dubbo] oldratlee commented on issue #2884: We
need more code comments
Posted by "oldratlee (GitHub)" <gi...@apache.org>.
Attach the the coverage data of comments in code(commit id: 1f751a602654f52d1ea86488a66d56c2a8faced6 ):
```zsh
$ ohcount **/src/main/; ohcount **/src/test/
Examining 855 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 770 56411 22867 28.8% 12220 91498
xmlschema 2 2563 0 0.0% 67 2630
shell 5 240 6 2.4% 26 272
xml 4 40 71 64.0% 25 136
bat 1 22 1 4.3% 6 29
---------------- ----- --------- --------- --------- --------- ---------
Total 782 59276 22945 27.9% 12344 94565
Examining 746 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 631 47409 12869 21.3% 10913 71191
xml 58 786 935 54.3% 348 2069
---------------- ----- --------- --------- --------- --------- ---------
Total 689 48195 13804 22.3% 11261 73260
```
[ Full content available at: https://github.com/apache/incubator-dubbo/issues/2884 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org
[GitHub] [incubator-dubbo] khanimteyaz commented on issue #2884: We
need more code comments
Posted by "khanimteyaz (GitHub)" <gi...@apache.org>.
How can I create the card under project (https://github.com/apache/incubator-dubbo/projects/2) and assigned it to me, so that it can be easier for reported to track.
[ Full content available at: https://github.com/apache/incubator-dubbo/issues/2884 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org
[GitHub] [incubator-dubbo] khanimteyaz commented on issue #2884: We
need more code comments
Posted by "khanimteyaz (GitHub)" <gi...@apache.org>.
@ralf0131 thanks for doing it.Appreciate it.
[ Full content available at: https://github.com/apache/incubator-dubbo/issues/2884 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org
[GitHub] [incubator-dubbo] oldratlee commented on issue #2884: We
need more code comments
Posted by "oldratlee (GitHub)" <gi...@apache.org>.
comment coverage report generated by below script: ☺️
module | product code | test code
------ | ------------ | ---------
dubbo-registry-redis | 6.8% | 16.5%
dubbo-registry-multicast | 10.9% | 34.1%
dubbo-rpc-redis | 11.1% | 16.5%
dubbo-registry-zookeeper | 12.9% | 14.5%
dubbo-rpc-webservice | 13.4% | 41.5%
dubbo-monitor-default | 15.4% | 18.1%
dubbo-rpc-http | 15.8% | 22.0%
dubbo-remoting-netty | 16.2% | 34.4%
dubbo-rpc-dubbo | 16.9% | 21.4%
dubbo-rpc-memcached | 17.0% | 84.2%
dubbo-remoting-mina | 17.7% | 48.1%
dubbo-remoting-grizzly | 19.4% | -
dubbo-rpc-thrift | 20.6% | 11.3%
dubbo-serialization-fastjson | 20.9% | -
dubbo-remoting-netty4 | 21.1% | 37.2%
dubbo-container-log4j | 21.3% | 61.3%
dubbo-config-api | 21.9% | 22.9%
dubbo-rpc-hessian | 21.9% | 20.0%
dubbo-registry-api | 22.2% | 20.8%
dubbo-registry-default | 23.4% | 17.0%
dubbo-serialization-protostuff | 24.1% | -
dubbo-serialization-fst | 24.6% | -
dubbo-common | 25.9% | 23.2%
dubbo-remoting-zookeeper | 26.0% | 22.9%
dubbo-rpc-rest | 28.4% | 33.8%
dubbo-rpc-rmi | 28.7% | 52.4%
dubbo-serialization-jdk | 28.8% | -
dubbo-filter-validation | 28.9% | 32.9%
dubbo-serialization-hessian2 | 30.3% | -
dubbo-config-spring | 30.7% | 26.7%
dubbo-serialization-kryo | 31.0% | -
dubbo-rpc-injvm | 31.7% | 39.2%
dubbo-remoting-api | 33.2% | 17.4%
dubbo-remoting-p2p | 33.4% | 23.6%
dubbo-container-logback | 33.7% | 48.7%
dubbo-qos | 34.3% | 32.6%
dubbo-container-spring | 34.5% | 57.6%
dubbo-cluster | 35.5% | 19.4%
dubbo-container-api | 35.8% | -
dubbo-rpc-api | 36.0% | 31.0%
dubbo-monitor-api | 37.0% | 15.4%
dubbo-filter-cache | 38.3% | 32.2%
dubbo-compatible | 40.3% | 23.8%
dubbo-remoting-http | 47.4% | 34.8%
dubbo-metrics-api | 50.8% | 19.9%
dubbo-test-spring3 | 51.5% | -
dubbo-demo-consumer | 52.5% | -
dubbo-demo-provider | 63.8% | -
dubbo-serialization-api | 79.1% | -
dubbo-demo-api | 80.0% | -
--------------
`comment-coverage-report.sh`:
```bash
#!/bin/bash
# comment-coverage-report.sh
# generate comment coverage report, markdown table format
#
# NOTE:
# 1. run at project root dir
# 2. install ohcount: https://github.com/blackducksw/ohcount
# if you use mac install by brew: brew install ohcount
set -o pipefail
set -e
set -u
getCommentCoverage() {
local dir="$1"
local comment_coverage="$(ohcount "$dir" | awk '/^java /{print $5}')"
echo "${comment_coverage:--}"
}
getCommentCoveragePerModule() {
local pom
for pom in `find -name pom.xml`; do
local module_dir="$(dirname "$pom")"
local module_name="$(basename "$module_dir")"
local module_product_code_dir="$module_dir/src/main/java"
local module_test_code_dir="$module_dir/src/test/java"
# no product code dir, skip
[ ! -d "$module_product_code_dir" ] && continue
# output comment coverage table line of module
echo "$module_name | $(getCommentCoverage "$module_product_code_dir") | $(getCommentCoverage "$module_test_code_dir")"
done
}
genCommentCoverageReport() {
# output table header
echo "module | product code | test code"
echo "------ | ------------ | ---------"
# output table body
getCommentCoveragePerModule | sort '-t|' -n -k2
}
genCommentCoverageReport
```
[ Full content available at: https://github.com/apache/incubator-dubbo/issues/2884 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org
[GitHub] [incubator-dubbo] khanimteyaz commented on issue #2884: We
need more code comments
Posted by "khanimteyaz (GitHub)" <gi...@apache.org>.
@ralf0131 I have raised a pull request regarding the current thread issue #2921 ,should bring #2921 issue into this group and close it as well as it got merged to master?
[ Full content available at: https://github.com/apache/incubator-dubbo/issues/2884 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org
[GitHub] [incubator-dubbo] oldratlee commented on issue #2884: We
need more code comments
Posted by "oldratlee (GitHub)" <gi...@apache.org>.
comment coverage report for https://github.com/apache/incubator-dubbo/commit/1f751a602654f52d1ea86488a66d56c2a8faced6 by below script:
module | product code | test code
------ | ------------ | ---------
dubbo-demo-api | 0.0% (0/3) | -
dubbo-serialization-fastjson | 0.0% (0/179) | -
dubbo-serialization-fst | 0.0% (0/192) | -
dubbo-serialization-protostuff | 1.0% (3/305) | -
dubbo-rpc-http | 1.6% (3/184) | 4.3% (9/199)
dubbo-registry-redis | 1.7% (10/572) | 0.0% (0/80)
dubbo-rpc-redis | 1.9% (3/151) | 1.7% (3/175)
dubbo-remoting-zookeeper | 2.4% (12/479) | 0.0% (0/264)
dubbo-rpc-webservice | 2.4% (3/122) | 12.8% (16/109)
dubbo-registry-zookeeper | 2.9% (8/268) | 3.3% (4/117)
dubbo-serialization-jdk | 3.1% (12/376) | -
dubbo-rpc-memcached | 3.2% (3/92) | 0.0% (0/2)
dubbo-rpc-hessian | 3.4% (9/257) | 3.8% (9/225)
dubbo-serialization-hessian2 | 3.7% (6/157) | -
dubbo-registry-multicast | 3.8% (15/382) | 23.3% (44/145)
dubbo-remoting-mina | 4.0% (23/549) | 20.2% (34/134)
dubbo-container-log4j | 4.2% (3/69) | 21.4% (3/11)
dubbo-monitor-default | 4.6% (17/354) | 1.9% (6/313)
dubbo-remoting-netty | 4.9% (52/1007) | 11.1% (68/544)
dubbo-remoting-grizzly | 5.1% (27/506) | -
dubbo-rpc-dubbo | 6.0% (173/2716) | 5.3% (111/1969)
dubbo-rpc-rest | 7.3% (58/738) | 3.6% (11/294)
dubbo-rpc-thrift | 7.5% (93/1149) | 8.2% (677/7596)
dubbo-serialization-kryo | 7.5% (34/422) | -
dubbo-container-spring | 7.9% (3/35) | 18.8% (3/13)
dubbo-filter-validation | 8.6% (33/349) | 0.0% (0/158)
dubbo-rpc-injvm | 10.1% (15/133) | 6.1% (12/185)
dubbo-compatible | 10.3% (245/2136) | 0.7% (11/1545)
dubbo-rpc-rmi | 10.6% (13/110) | 34.2% (80/154)
dubbo-registry-default | 11.4% (23/178) | 10.1% (172/1529)
dubbo-remoting-p2p | 12.1% (117/852) | 0.0% (0/152)
dubbo-remoting-netty4 | 12.2% (168/1213) | 7.6% (20/242)
dubbo-container-api | 13.5% (12/77) | -
dubbo-cluster | 14.1% (408/2482) | 7.6% (278/3387)
dubbo-registry-api | 14.9% (350/1996) | 14.0% (129/791)
dubbo-config-api | 16.1% (762/3962) | 4.9% (212/4103)
dubbo-filter-cache | 16.8% (96/477) | 0.0% (0/196)
dubbo-qos | 17.3% (289/1384) | 0.0% (0/706)
dubbo-common | 18.6% (3414/14930) | 1.8% (159/8688)
dubbo-monitor-api | 19.1% (52/220) | 2.8% (6/206)
dubbo-container-logback | 19.4% (14/58) | 13.6% (3/19)
dubbo-config-spring | 19.6% (683/2807) | 7.6% (238/2893)
dubbo-remoting-api | 20.3% (1545/6054) | 6.0% (255/3979)
dubbo-remoting-http | 20.5% (79/306) | 0.0% (0/58)
dubbo-demo-provider | 20.8% (5/19) | -
dubbo-test-spring3 | 21.1% (20/75) | -
dubbo-rpc-api | 21.2% (1036/3851) | 4.7% (76/1551)
dubbo-demo-consumer | 21.7% (5/18) | -
dubbo-metrics-api | 40.5% (405/595) | 0.0% (0/127)
dubbo-serialization-api | 71.6% (194/77) | -
--------------
`comment-coverage-report.sh`:
https://gist.github.com/oldratlee/6d02a849b8b84a9aba26be7ee65f5560
[ Full content available at: https://github.com/apache/incubator-dubbo/issues/2884 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org
[GitHub] [incubator-dubbo] oldratlee commented on issue #2884: We
need more code comments
Posted by "oldratlee (GitHub)" <gi...@apache.org>.
comment coverage report of https://github.com/apache/incubator-dubbo/commit/1f751a602654f52d1ea86488a66d56c2a8faced6 generated by below script:
module | product code | test code
------ | ------------ | ---------
dubbo-demo-api | 0.0% (0/3) | -
dubbo-serialization-fastjson | 0.0% (0/179) | -
dubbo-serialization-fst | 0.0% (0/192) | -
dubbo-serialization-protostuff | 1.0% (3/305) | -
dubbo-rpc-http | 1.6% (3/184) | 4.3% (9/199)
dubbo-registry-redis | 1.7% (10/572) | 0.0% (0/80)
dubbo-rpc-redis | 1.9% (3/151) | 1.7% (3/175)
dubbo-remoting-zookeeper | 2.4% (12/479) | 0.0% (0/264)
dubbo-rpc-webservice | 2.4% (3/122) | 12.8% (16/109)
dubbo-registry-zookeeper | 2.9% (8/268) | 3.3% (4/117)
dubbo-serialization-jdk | 3.1% (12/376) | -
dubbo-rpc-memcached | 3.2% (3/92) | 0.0% (0/2)
dubbo-rpc-hessian | 3.4% (9/257) | 3.8% (9/225)
dubbo-serialization-hessian2 | 3.7% (6/157) | -
dubbo-registry-multicast | 3.8% (15/382) | 23.3% (44/145)
dubbo-remoting-mina | 4.0% (23/549) | 20.2% (34/134)
dubbo-container-log4j | 4.2% (3/69) | 21.4% (3/11)
dubbo-monitor-default | 4.6% (17/354) | 1.9% (6/313)
dubbo-remoting-netty | 4.9% (52/1007) | 11.1% (68/544)
dubbo-remoting-grizzly | 5.1% (27/506) | -
dubbo-rpc-dubbo | 6.0% (173/2716) | 5.3% (111/1969)
dubbo-rpc-rest | 7.3% (58/738) | 3.6% (11/294)
dubbo-rpc-thrift | 7.5% (93/1149) | 8.2% (677/7596)
dubbo-serialization-kryo | 7.5% (34/422) | -
dubbo-container-spring | 7.9% (3/35) | 18.8% (3/13)
dubbo-filter-validation | 8.6% (33/349) | 0.0% (0/158)
dubbo-rpc-injvm | 10.1% (15/133) | 6.1% (12/185)
dubbo-compatible | 10.3% (245/2136) | 0.7% (11/1545)
dubbo-rpc-rmi | 10.6% (13/110) | 34.2% (80/154)
dubbo-registry-default | 11.4% (23/178) | 10.1% (172/1529)
dubbo-remoting-p2p | 12.1% (117/852) | 0.0% (0/152)
dubbo-remoting-netty4 | 12.2% (168/1213) | 7.6% (20/242)
dubbo-container-api | 13.5% (12/77) | -
dubbo-cluster | 14.1% (408/2482) | 7.6% (278/3387)
dubbo-registry-api | 14.9% (350/1996) | 14.0% (129/791)
dubbo-config-api | 16.1% (762/3962) | 4.9% (212/4103)
dubbo-filter-cache | 16.8% (96/477) | 0.0% (0/196)
dubbo-qos | 17.3% (289/1384) | 0.0% (0/706)
dubbo-common | 18.6% (3414/14930) | 1.8% (159/8688)
dubbo-monitor-api | 19.1% (52/220) | 2.8% (6/206)
dubbo-container-logback | 19.4% (14/58) | 13.6% (3/19)
dubbo-config-spring | 19.6% (683/2807) | 7.6% (238/2893)
dubbo-remoting-api | 20.3% (1545/6054) | 6.0% (255/3979)
dubbo-remoting-http | 20.5% (79/306) | 0.0% (0/58)
dubbo-demo-provider | 20.8% (5/19) | -
dubbo-test-spring3 | 21.1% (20/75) | -
dubbo-rpc-api | 21.2% (1036/3851) | 4.7% (76/1551)
dubbo-demo-consumer | 21.7% (5/18) | -
dubbo-metrics-api | 40.5% (405/595) | 0.0% (0/127)
dubbo-serialization-api | 71.6% (194/77) | -
--------------
`comment-coverage-report.sh`:
https://gist.github.com/oldratlee/6d02a849b8b84a9aba26be7ee65f5560
[ Full content available at: https://github.com/apache/incubator-dubbo/issues/2884 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org
[GitHub] [incubator-dubbo] oldratlee commented on issue #2884: We
need more code comments
Posted by "oldratlee (GitHub)" <gi...@apache.org>.
comment coverage report generated by below scripts: ☺️
module | product code | test code
------ | ------------ | ---------
dubbo-registry-redis | 6.8% | 16.5%
dubbo-registry-multicast | 10.9% | 34.1%
dubbo-rpc-redis | 11.1% | 16.5%
dubbo-registry-zookeeper | 12.9% | 14.5%
dubbo-rpc-webservice | 13.4% | 41.5%
dubbo-monitor-default | 15.4% | 18.1%
dubbo-rpc-http | 15.8% | 22.0%
dubbo-remoting-netty | 16.2% | 34.4%
dubbo-rpc-dubbo | 16.9% | 21.4%
dubbo-rpc-memcached | 17.0% | 84.2%
dubbo-remoting-mina | 17.7% | 48.1%
dubbo-remoting-grizzly | 19.4% | -
dubbo-rpc-thrift | 20.6% | 11.3%
dubbo-serialization-fastjson | 20.9% | -
dubbo-remoting-netty4 | 21.1% | 37.2%
dubbo-container-log4j | 21.3% | 61.3%
dubbo-config-api | 21.9% | 22.9%
dubbo-rpc-hessian | 21.9% | 20.0%
dubbo-registry-api | 22.2% | 20.8%
dubbo-registry-default | 23.4% | 17.0%
dubbo-serialization-protostuff | 24.1% | -
dubbo-serialization-fst | 24.6% | -
dubbo-common | 25.9% | 23.2%
dubbo-remoting-zookeeper | 26.0% | 22.9%
dubbo-rpc-rest | 28.4% | 33.8%
dubbo-rpc-rmi | 28.7% | 52.4%
dubbo-serialization-jdk | 28.8% | -
dubbo-filter-validation | 28.9% | 32.9%
dubbo-serialization-hessian2 | 30.3% | -
dubbo-config-spring | 30.7% | 26.7%
dubbo-serialization-kryo | 31.0% | -
dubbo-rpc-injvm | 31.7% | 39.2%
dubbo-remoting-api | 33.2% | 17.4%
dubbo-remoting-p2p | 33.4% | 23.6%
dubbo-container-logback | 33.7% | 48.7%
dubbo-qos | 34.3% | 32.6%
dubbo-container-spring | 34.5% | 57.6%
dubbo-cluster | 35.5% | 19.4%
dubbo-container-api | 35.8% | -
dubbo-rpc-api | 36.0% | 31.0%
dubbo-monitor-api | 37.0% | 15.4%
dubbo-filter-cache | 38.3% | 32.2%
dubbo-compatible | 40.3% | 23.8%
dubbo-remoting-http | 47.4% | 34.8%
dubbo-metrics-api | 50.8% | 19.9%
dubbo-test-spring3 | 51.5% | -
dubbo-demo-consumer | 52.5% | -
dubbo-demo-provider | 63.8% | -
dubbo-serialization-api | 79.1% | -
dubbo-demo-api | 80.0% | -
--------------
`comment-coverage-report.sh`:
```bash
#!/bin/bash
# comment-coverage-report.sh
# generate comment coverage report, markdown table format
#
# NOTE:
# 1. run at project root dir
# 2. install ohcount: https://github.com/blackducksw/ohcount
# if you use mac install by brew: brew install ohcount
set -o pipefail
set -e
set -u
getCommentCoverage() {
local dir="$1"
local comment_coverage="$(ohcount "$dir" | awk '/^java /{print $5}')"
echo "${comment_coverage:--}"
}
getCommentCoveragePerModule() {
local pom
for pom in `find -name pom.xml`; do
local module_dir="$(dirname "$pom")"
local module_name="$(basename "$module_dir")"
local module_product_code_dir="$module_dir/src/main/java"
local module_test_code_dir="$module_dir/src/test/java"
# no product code dir, skip
[ ! -d "$module_product_code_dir" ] && continue
# output comment coverage table line of module
echo "$module_name | $(getCommentCoverage "$module_product_code_dir") | $(getCommentCoverage "$module_test_code_dir")"
done
}
genCommentCoverageReport() {
# output table header
echo "module | product code | test code"
echo "------ | ------------ | ---------"
# output table body
getCommentCoveragePerModule | sort '-t|' -n -k2
}
genCommentCoverageReport
```
[ Full content available at: https://github.com/apache/incubator-dubbo/issues/2884 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org
[GitHub] [incubator-dubbo] khanimteyaz commented on issue #2884: We
need more code comments
Posted by "khanimteyaz (GitHub)" <gi...@apache.org>.
Being a new to open source development mythology will be possible for some one to guide me how I can proceed further to help the community regarding the current issue.
[ Full content available at: https://github.com/apache/incubator-dubbo/issues/2884 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org
[GitHub] [incubator-dubbo] khanimteyaz commented on issue #2884: We
need more code comments
Posted by "khanimteyaz (GitHub)" <gi...@apache.org>.
Created the [pull ](https://github.com/apache/incubator-dubbo/pull/2921)request for addition of comments for dubbo-filter module
[ Full content available at: https://github.com/apache/incubator-dubbo/issues/2884 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org
[GitHub] [incubator-dubbo] oldratlee commented on issue #2884: We
need more code comments
Posted by "oldratlee (GitHub)" <gi...@apache.org>.
comment coverage report generated by below scripts: ☺️
module | product code | test code
------ | ------------ | ---------
dubbo-registry-redis | 6.8% | 16.5%
dubbo-registry-multicast | 10.9% | 34.1%
dubbo-rpc-redis | 11.1% | 16.5%
dubbo-registry-zookeeper | 12.9% | 14.5%
dubbo-rpc-webservice | 13.4% | 41.5%
dubbo-monitor-default | 15.4% | 18.1%
dubbo-rpc-http | 15.8% | 22.0%
dubbo-remoting-netty | 16.2% | 34.4%
dubbo-rpc-dubbo | 16.9% | 21.4%
dubbo-rpc-memcached | 17.0% | 84.2%
dubbo-remoting-mina | 17.7% | 48.1%
dubbo-remoting-grizzly | 19.4% | -
dubbo-rpc-thrift | 20.6% | 11.3%
dubbo-serialization-fastjson | 20.9% | -
dubbo-remoting-netty4 | 21.1% | 37.2%
dubbo-container-log4j | 21.3% | 61.3%
dubbo-config-api | 21.9% | 22.9%
dubbo-rpc-hessian | 21.9% | 20.0%
dubbo-registry-api | 22.2% | 20.8%
dubbo-registry-default | 23.4% | 17.0%
dubbo-serialization-protostuff | 24.1% | -
dubbo-serialization-fst | 24.6% | -
dubbo-common | 25.9% | 23.2%
dubbo-remoting-zookeeper | 26.0% | 22.9%
dubbo-rpc-rest | 28.4% | 33.8%
dubbo-rpc-rmi | 28.7% | 52.4%
dubbo-serialization-jdk | 28.8% | -
dubbo-filter-validation | 28.9% | 32.9%
dubbo-serialization-hessian2 | 30.3% | -
dubbo-config-spring | 30.7% | 26.7%
dubbo-serialization-kryo | 31.0% | -
dubbo-rpc-injvm | 31.7% | 39.2%
dubbo-remoting-api | 33.2% | 17.4%
dubbo-remoting-p2p | 33.4% | 23.6%
dubbo-container-logback | 33.7% | 48.7%
dubbo-qos | 34.3% | 32.6%
dubbo-container-spring | 34.5% | 57.6%
dubbo-cluster | 35.5% | 19.4%
dubbo-container-api | 35.8% | -
dubbo-rpc-api | 36.0% | 31.0%
dubbo-monitor-api | 37.0% | 15.4%
dubbo-filter-cache | 38.3% | 32.2%
dubbo-compatible | 40.3% | 23.8%
dubbo-remoting-http | 47.4% | 34.8%
dubbo-metrics-api | 50.8% | 19.9%
dubbo-test-spring3 | 51.5% | -
dubbo-demo-consumer | 52.5% | -
dubbo-demo-provider | 63.8% | -
dubbo-serialization-api | 79.1% | -
dubbo-demo-api | 80.0% | -
--------------
`comment-coverage-report.sh`:
```bash
#!/bin/bash
# comment-coverage-report.sh
# generate comment coverage report, markdown table format
#
# NOTE:
# 1. run at project root dir
# 2. install ohcount: https://github.com/blackducksw/ohcount
# if you use mac install by brew: brew install ohcount
set -o pipefail
set -e
set -u
getCommentCoverage() {
local dir="$1"
local comment_coverage="$(ohcount "$dir" | awk '/^java /{print $5}')"
comment_coverage="${comment_coverage:--}"
echo "$comment_coverage"
}
getCommentCoveragePerModule() {
local pom
for pom in `find -name pom.xml`; do
local module_dir="$(dirname "$pom")"
local module_name="$(basename "$module_dir")"
local module_product_code_dir="$module_dir/src/main/java"
local module_test_code_dir="$module_dir/src/test/java"
[ ! -d "$module_product_code_dir" ] && continue
echo "$module_name | $(getCommentCoverage "$module_product_code_dir") | $(getCommentCoverage "$module_test_code_dir")"
done
}
genCommentCoverageReport() {
# output table header
echo "module | product code | test code"
echo "------ | ------------ | ---------"
# output table body
getCommentCoveragePerModule | sort '-t|' -n -k2
}
genCommentCoverageReport
```
[ Full content available at: https://github.com/apache/incubator-dubbo/issues/2884 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org
[GitHub] [incubator-dubbo] oldratlee commented on issue #2884: We
need more code comments
Posted by "oldratlee (GitHub)" <gi...@apache.org>.
Attach the the coverage data of comments in code(commit id: 46b3458564cd0387d50f26f566556917cb74b999 ):
```zsh
$ ohcount **/src/main/; ohcount **/src/test/
Examining 855 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 770 56418 22867 28.8% 12220 91505
xmlschema 2 2563 0 0.0% 67 2630
shell 5 240 6 2.4% 26 272
xml 4 40 71 64.0% 25 136
bat 1 22 1 4.3% 6 29
---------------- ----- --------- --------- --------- --------- ---------
Total 782 59283 22945 27.9% 12344 94572
Examining 746 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 631 47369 12870 21.4% 10910 71149
xml 58 786 935 54.3% 348 2069
---------------- ----- --------- --------- --------- --------- ---------
Total 689 48155 13805 22.3% 11258 73218
```
[ Full content available at: https://github.com/apache/incubator-dubbo/issues/2884 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org
[GitHub] [incubator-dubbo] oldratlee commented on issue #2884: We
need more code comments
Posted by "oldratlee (GitHub)" <gi...@apache.org>.
comment coverage report of 1f751a602654f52d1ea86488a66d56c2a8faced6 generated by below script:
NO. | module | product code | test code
--- | ------ | ------------ | ---------
1 | dubbo-demo-api | 0.0% (0/3) | -
2 | dubbo-serialization-fastjson | 0.0% (0/179) | -
3 | dubbo-serialization-fst | 0.0% (0/192) | -
4 | dubbo-serialization-protostuff | 1.0% (3/305) | -
5 | dubbo-rpc-http | 1.6% (3/184) | 4.3% (9/199)
6 | dubbo-registry-redis | 1.7% (10/572) | 0.0% (0/80)
7 | dubbo-rpc-redis | 1.9% (3/151) | 1.7% (3/175)
8 | dubbo-remoting-zookeeper | 2.4% (12/479) | 0.0% (0/264)
9 | dubbo-rpc-webservice | 2.4% (3/122) | 12.8% (16/109)
10 | dubbo-registry-zookeeper | 2.9% (8/268) | 3.3% (4/117)
11 | dubbo-serialization-jdk | 3.1% (12/376) | -
12 | dubbo-rpc-memcached | 3.2% (3/92) | 0.0% (0/2)
13 | dubbo-rpc-hessian | 3.4% (9/257) | 3.8% (9/225)
14 | dubbo-serialization-hessian2 | 3.7% (6/157) | -
15 | dubbo-registry-multicast | 3.8% (15/382) | 23.3% (44/145)
16 | dubbo-remoting-mina | 4.0% (23/549) | 20.2% (34/134)
17 | dubbo-container-log4j | 4.2% (3/69) | 21.4% (3/11)
18 | dubbo-monitor-default | 4.6% (17/354) | 1.9% (6/313)
19 | dubbo-remoting-netty | 4.9% (52/1007) | 11.1% (68/544)
20 | dubbo-remoting-grizzly | 5.1% (27/506) | -
21 | dubbo-rpc-dubbo | 6.0% (173/2716) | 5.3% (111/1969)
22 | dubbo-rpc-rest | 7.3% (58/738) | 3.6% (11/294)
23 | dubbo-rpc-thrift | 7.5% (93/1149) | 8.2% (677/7596)
24 | dubbo-serialization-kryo | 7.5% (34/422) | -
25 | dubbo-container-spring | 7.9% (3/35) | 18.8% (3/13)
26 | dubbo-filter-validation | 8.6% (33/349) | 0.0% (0/158)
27 | dubbo-rpc-injvm | 10.1% (15/133) | 6.1% (12/185)
28 | dubbo-compatible | 10.3% (245/2136) | 0.7% (11/1545)
29 | dubbo-rpc-rmi | 10.6% (13/110) | 34.2% (80/154)
30 | dubbo-registry-default | 11.4% (23/178) | 10.1% (172/1529)
31 | dubbo-remoting-p2p | 12.1% (117/852) | 0.0% (0/152)
32 | dubbo-remoting-netty4 | 12.2% (168/1213) | 7.6% (20/242)
33 | dubbo-container-api | 13.5% (12/77) | -
34 | dubbo-cluster | 14.1% (408/2482) | 7.6% (278/3387)
35 | dubbo-registry-api | 14.9% (350/1996) | 14.0% (129/791)
36 | dubbo-config-api | 16.1% (762/3962) | 4.9% (212/4103)
37 | dubbo-filter-cache | 16.8% (96/477) | 0.0% (0/196)
38 | dubbo-qos | 17.3% (289/1384) | 0.0% (0/706)
39 | dubbo-common | 18.6% (3414/14930) | 1.8% (159/8688)
40 | dubbo-monitor-api | 19.1% (52/220) | 2.8% (6/206)
41 | dubbo-container-logback | 19.4% (14/58) | 13.6% (3/19)
42 | dubbo-config-spring | 19.6% (683/2807) | 7.6% (238/2893)
43 | dubbo-remoting-api | 20.3% (1545/6054) | 6.0% (255/3979)
44 | dubbo-remoting-http | 20.5% (79/306) | 0.0% (0/58)
45 | dubbo-demo-provider | 20.8% (5/19) | -
46 | dubbo-test-spring3 | 21.1% (20/75) | -
47 | dubbo-rpc-api | 21.2% (1036/3851) | 4.7% (76/1551)
48 | dubbo-demo-consumer | 21.7% (5/18) | -
49 | dubbo-metrics-api | 40.5% (405/595) | 0.0% (0/127)
50 | dubbo-serialization-api | 71.6% (194/77) | -
--------------
`comment-coverage-report.sh`:
https://gist.github.com/oldratlee/6d02a849b8b84a9aba26be7ee65f5560
[ Full content available at: https://github.com/apache/incubator-dubbo/issues/2884 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org
[GitHub] [incubator-dubbo] oldratlee commented on issue #2884: We
need more code comments
Posted by "oldratlee (GitHub)" <gi...@apache.org>.
> @ralf0131
> @oldratlee Can you break it down by modules? We can start from the lowest.
comment coverage data per module sorted by product code:
module | product code | test code
------- | --------- | ----------
dubbo-registry | 18.2% | 19.2%
dubbo-monitor | 25.3% | 17.1%
dubbo-config | 25.8% | 24.5%
dubbo-common | 25.9% | 23.2%
dubbo-rpc | 27.4% | 18.3%
dubbo-remoting | 29.8% | 22.4%
dubbo-container | 31.5% | 55.3%
dubbo-plugin | 34.3% | 32.6%
dubbo-filter | 34.7% | 32.5%
dubbo-serialization | 35.2% | 16.8%
dubbo-cluster | 35.5% | 19.4%
dubbo-compatible | 40.3% | 23.8%
dubbo-metrics | 50.8% | 19.9%
dubbo-test | 51.5% | -
dubbo-demo | 62.7% | -
PS：
If needed, I can write a script to generate above table.
----------------------
Below is the quick-hack script to show coverage data per module:
```bash
$ for d in `find -mindepth 1 -maxdepth 1 -type d -name 'dubbo*'`; do (
echo
echo "===================================="
echo $d
echo "===================================="
cd $d
ohcount **/src/main/; ohcount **/src/test/
)
done
......
====================================
./dubbo-cluster
====================================
Examining 67 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 62 2544 1400 35.5% 490 4434
---------------- ----- --------- --------- --------- --------- ---------
Total 62 2544 1400 35.5% 490 4434
Examining 38 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 34 3421 822 19.4% 706 4949
xml 1 13 14 51.9% 2 29
---------------- ----- --------- --------- --------- --------- ---------
Total 35 3434 836 19.6% 708 4978
====================================
./dubbo-common
====================================
Examining 121 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 115 15045 5248 25.9% 2610 22903
---------------- ----- --------- --------- --------- --------- ---------
Total 115 15045 5248 25.9% 2610 22903
Examining 183 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 158 8846 2671 23.2% 1899 13416
xml 1 14 18 56.2% 0 32
---------------- ----- --------- --------- --------- --------- ---------
Total 159 8860 2689 23.3% 1899 13448
......
```
[ Full content available at: https://github.com/apache/incubator-dubbo/issues/2884 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org
[GitHub] [incubator-dubbo] khanimteyaz commented on issue #2884: We
need more code comments
Posted by "khanimteyaz (GitHub)" <gi...@apache.org>.
Hi All,
I have raised the PR <https://github.com/apache/incubator-dubbo/pull/2967>for
issue id 2935 <https://github.com/apache/incubator-dubbo/issues/2935> (adding
dubbo-rpc-api) documentation for filter package. Please review my PR.
https://github.com/apache/incubator-dubbo/pull/2967
Thanks in advance.
On Tue, Dec 11, 2018 at 3:25 PM Huxing Zhang <no...@github.com>
wrote:
> @khanimteyaz <https://github.com/khanimteyaz> I've added #2921
> <https://github.com/apache/incubator-dubbo/pull/2921> to
> https://github.com/apache/incubator-dubbo/projects/2, and marked it as
> Done.
>
> —
> You are receiving this because you were mentioned.
> Reply to this email directly, view it on GitHub
> <https://github.com/apache/incubator-dubbo/issues/2884#issuecomment-446140079>,
> or mute the thread
> <https://github.com/notifications/unsubscribe-auth/AdXcPfCVHdSJjVTrZ87jz4vdQ9BvAZYVks5u34EggaJpZM4ZAMhZ>
> .
>
[ Full content available at: https://github.com/apache/incubator-dubbo/issues/2884 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org
[GitHub] [incubator-dubbo] oldratlee commented on issue #2884: We
need more code comments
Posted by "oldratlee (GitHub)" <gi...@apache.org>.
> @lovepoem
> @oldratlee，can we statistics the comment coverage as test coverage in the codecov.io ?
I have found comment coverage info in the codecov.io yet.
[ Full content available at: https://github.com/apache/incubator-dubbo/issues/2884 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org
[GitHub] [incubator-dubbo] oldratlee commented on issue #2884: We
need more code comments
Posted by "oldratlee (GitHub)" <gi...@apache.org>.
> @ralf0131
> @oldratlee Can you break it down by modules? We can start from the lowest.
coverage data per module sorted by product code:
module | product code | test code
------- | --------- | ----------
dubbo-registry | 18.2% | 19.2%
dubbo-monitor | 25.3% | 17.1%
dubbo-config | 25.8% | 24.5%
dubbo-common | 25.9% | 23.2%
dubbo-rpc | 27.4% | 18.3%
dubbo-remoting | 29.8% | 22.4%
dubbo-container | 31.5% | 55.3%
dubbo-plugin | 34.3% | 32.6%
dubbo-filter | 34.7% | 32.5%
dubbo-serialization | 35.2% | 16.8%
dubbo-cluster | 35.5% | 19.4%
dubbo-compatible | 40.3% | 23.8%
dubbo-metrics | 50.8% | 19.9%
dubbo-test | 51.5% | -
dubbo-demo | 62.7% | -
----------------------
Below is the quick-hack script to show coverage data per module:
```bash
$ for d in `find -mindepth 1 -maxdepth 1 -type d -name 'dubbo*'`; do (
echo
echo "===================================="
echo $d
echo "===================================="
cd $d
ohcount **/src/main/; ohcount **/src/test/
)
done
====================================
./dubbo-all
====================================
zsh: no matches found: **/src/main/
zsh: no matches found: **/src/test/
====================================
./dubbo-bom
====================================
zsh: no matches found: **/src/main/
zsh: no matches found: **/src/test/
====================================
./dubbo-cluster
====================================
Examining 67 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 62 2544 1400 35.5% 490 4434
---------------- ----- --------- --------- --------- --------- ---------
Total 62 2544 1400 35.5% 490 4434
Examining 38 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 34 3421 822 19.4% 706 4949
xml 1 13 14 51.9% 2 29
---------------- ----- --------- --------- --------- --------- ---------
Total 35 3434 836 19.6% 708 4978
====================================
./dubbo-common
====================================
Examining 121 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 115 15045 5248 25.9% 2610 22903
---------------- ----- --------- --------- --------- --------- ---------
Total 115 15045 5248 25.9% 2610 22903
Examining 183 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 158 8846 2671 23.2% 1899 13416
xml 1 14 18 56.2% 0 32
---------------- ----- --------- --------- --------- --------- ---------
Total 159 8860 2689 23.3% 1899 13448
====================================
./dubbo-compatible
====================================
Examining 78 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 78 2214 1493 40.3% 915 4622
---------------- ----- --------- --------- --------- --------- ---------
Total 78 2214 1493 40.3% 915 4622
Examining 31 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 30 1575 491 23.8% 369 2435
---------------- ----- --------- --------- --------- --------- ---------
Total 30 1575 491 23.8% 369 2435
====================================
./dubbo-config
====================================
Examining 64 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 58 6827 2373 25.8% 1826 11026
xmlschema 2 2563 0 0.0% 67 2630
---------------- ----- --------- --------- --------- --------- ---------
Total 60 9390 2373 20.2% 1893 13656
Examining 183 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 116 7112 2306 24.5% 1697 11115
xml 45 608 719 54.2% 311 1638
---------------- ----- --------- --------- --------- --------- ---------
Total 161 7720 3025 28.2% 2008 12753
====================================
./dubbo-container
====================================
Examining 14 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 5 244 112 31.5% 55 411
shell 5 240 6 2.4% 26 272
bat 1 22 1 4.3% 6 29
---------------- ----- --------- --------- --------- --------- ---------
Total 11 506 119 19.0% 87 712
Examining 5 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 3 46 57 55.3% 18 121
xml 2 19 28 59.6% 6 53
---------------- ----- --------- --------- --------- --------- ---------
Total 5 65 85 56.7% 24 174
====================================
./dubbo-demo
====================================
Examining 10 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 4 44 74 62.7% 15 133
xml 2 22 38 63.3% 14 74
---------------- ----- --------- --------- --------- --------- ---------
Total 6 66 112 62.9% 29 207
zsh: no matches found: **/src/test/
====================================
./dubbo-dependencies-bom
====================================
zsh: no matches found: **/src/main/
zsh: no matches found: **/src/test/
====================================
./dubbo-distribution
====================================
zsh: no matches found: **/src/main/
zsh: no matches found: **/src/test/
====================================
./dubbo-filter
====================================
Examining 24 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 20 846 449 34.7% 182 1477
---------------- ----- --------- --------- --------- --------- ---------
Total 20 846 449 34.7% 182 1477
Examining 11 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 11 365 176 32.5% 91 632
---------------- ----- --------- --------- --------- --------- ---------
Total 11 365 176 32.5% 91 632
====================================
./dubbo-metrics
====================================
Examining 14 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 14 609 629 50.8% 222 1460
---------------- ----- --------- --------- --------- --------- ---------
Total 14 609 629 50.8% 222 1460
Examining 2 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 2 129 32 19.9% 30 191
---------------- ----- --------- --------- --------- --------- ---------
Total 2 129 32 19.9% 30 191
====================================
./dubbo-monitor
====================================
Examining 10 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 8 582 197 25.3% 123 902
---------------- ----- --------- --------- --------- --------- ---------
Total 8 582 197 25.3% 123 902
Examining 6 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 6 525 108 17.1% 98 731
---------------- ----- --------- --------- --------- --------- ---------
Total 6 525 108 17.1% 98 731
====================================
./dubbo-plugin
====================================
Examining 30 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 28 1412 737 34.3% 371 2520
---------------- ----- --------- --------- --------- --------- ---------
Total 28 1412 737 34.3% 371 2520
Examining 24 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 22 728 352 32.6% 110 1190
---------------- ----- --------- --------- --------- --------- ---------
Total 22 728 352 32.6% 110 1190
====================================
./dubbo-registry
====================================
Examining 28 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 22 3418 758 18.2% 434 4610
---------------- ----- --------- --------- --------- --------- ---------
Total 22 3418 758 18.2% 434 4610
Examining 20 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 18 2680 637 19.2% 586 3903
xml 2 33 35 51.5% 4 72
---------------- ----- --------- --------- --------- --------- ---------
Total 20 2713 672 19.9% 590 3975
====================================
./dubbo-remoting
====================================
Examining 180 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 169 11153 4727 29.8% 2527 18407
---------------- ----- --------- --------- --------- --------- ---------
Total 169 11153 4727 29.8% 2527 18407
Examining 77 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 75 5448 1577 22.4% 1096 8121
xml 2 27 35 56.5% 4 66
---------------- ----- --------- --------- --------- --------- ---------
Total 77 5475 1612 22.7% 1100 8187
====================================
./dubbo-rpc
====================================
Examining 159 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 139 9642 3633 27.4% 1923 15198
---------------- ----- --------- --------- --------- --------- ---------
Total 139 9642 3633 27.4% 1923 15198
Examining 130 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 122 13662 3062 18.3% 3457 20181
xml 4 58 72 55.4% 19 149
---------------- ----- --------- --------- --------- --------- ---------
Total 126 13720 3134 18.6% 3476 20330
====================================
./dubbo-serialization
====================================
Examining 50 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 44 1752 953 35.2% 490 3195
---------------- ----- --------- --------- --------- --------- ---------
Total 44 1752 953 35.2% 490 3195
Examining 36 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 34 2872 578 16.8% 756 4206
xml 1 14 14 50.0% 2 30
---------------- ----- --------- --------- --------- --------- ---------
Total 35 2886 592 17.0% 758 4236
====================================
./dubbo-test
====================================
Examining 6 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 4 79 84 51.5% 37 200
xml 2 18 33 64.7% 11 62
---------------- ----- --------- --------- --------- --------- ---------
Total 6 97 117 54.7% 48 262
zsh: no matches found: **/src/test/
```
[ Full content available at: https://github.com/apache/incubator-dubbo/issues/2884 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org
[GitHub] [incubator-dubbo] khanimteyaz commented on issue #2884: We
need more code comments
Posted by "khanimteyaz (GitHub)" <gi...@apache.org>.
I am new to open source contribution world and new to dubbo also. I see this is has been tagged as 'Help wanted' and 'good first issue'. Is there any way I help one this one. Would request someone to be my mentor guide me here as well.
[ Full content available at: https://github.com/apache/incubator-dubbo/issues/2884 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org
[GitHub] [incubator-dubbo] oldratlee commented on issue #2884: We
need more code comments
Posted by "oldratlee (GitHub)" <gi...@apache.org>.
> @ralf0131
> @oldratlee Can you break it down by modules? We can start from the lowest.
comment coverage data per module sorted by product code:
module | product code | test code
------- | --------- | ----------
dubbo-registry | 18.2% | 19.2%
dubbo-monitor | 25.3% | 17.1%
dubbo-config | 25.8% | 24.5%
dubbo-common | 25.9% | 23.2%
dubbo-rpc | 27.4% | 18.3%
dubbo-remoting | 29.8% | 22.4%
dubbo-container | 31.5% | 55.3%
dubbo-plugin | 34.3% | 32.6%
dubbo-filter | 34.7% | 32.5%
dubbo-serialization | 35.2% | 16.8%
dubbo-cluster | 35.5% | 19.4%
dubbo-compatible | 40.3% | 23.8%
dubbo-metrics | 50.8% | 19.9%
dubbo-test | 51.5% | -
dubbo-demo | 62.7% | -
----------------------
Below is the quick-hack script to show coverage data per module:
```bash
$ for d in `find -mindepth 1 -maxdepth 1 -type d -name 'dubbo*'`; do (
echo
echo "===================================="
echo $d
echo "===================================="
cd $d
ohcount **/src/main/; ohcount **/src/test/
)
done
====================================
./dubbo-all
====================================
zsh: no matches found: **/src/main/
zsh: no matches found: **/src/test/
====================================
./dubbo-bom
====================================
zsh: no matches found: **/src/main/
zsh: no matches found: **/src/test/
====================================
./dubbo-cluster
====================================
Examining 67 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 62 2544 1400 35.5% 490 4434
---------------- ----- --------- --------- --------- --------- ---------
Total 62 2544 1400 35.5% 490 4434
Examining 38 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 34 3421 822 19.4% 706 4949
xml 1 13 14 51.9% 2 29
---------------- ----- --------- --------- --------- --------- ---------
Total 35 3434 836 19.6% 708 4978
====================================
./dubbo-common
====================================
Examining 121 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 115 15045 5248 25.9% 2610 22903
---------------- ----- --------- --------- --------- --------- ---------
Total 115 15045 5248 25.9% 2610 22903
Examining 183 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 158 8846 2671 23.2% 1899 13416
xml 1 14 18 56.2% 0 32
---------------- ----- --------- --------- --------- --------- ---------
Total 159 8860 2689 23.3% 1899 13448
====================================
./dubbo-compatible
====================================
Examining 78 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 78 2214 1493 40.3% 915 4622
---------------- ----- --------- --------- --------- --------- ---------
Total 78 2214 1493 40.3% 915 4622
Examining 31 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 30 1575 491 23.8% 369 2435
---------------- ----- --------- --------- --------- --------- ---------
Total 30 1575 491 23.8% 369 2435
====================================
./dubbo-config
====================================
Examining 64 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 58 6827 2373 25.8% 1826 11026
xmlschema 2 2563 0 0.0% 67 2630
---------------- ----- --------- --------- --------- --------- ---------
Total 60 9390 2373 20.2% 1893 13656
Examining 183 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 116 7112 2306 24.5% 1697 11115
xml 45 608 719 54.2% 311 1638
---------------- ----- --------- --------- --------- --------- ---------
Total 161 7720 3025 28.2% 2008 12753
====================================
./dubbo-container
====================================
Examining 14 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 5 244 112 31.5% 55 411
shell 5 240 6 2.4% 26 272
bat 1 22 1 4.3% 6 29
---------------- ----- --------- --------- --------- --------- ---------
Total 11 506 119 19.0% 87 712
Examining 5 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 3 46 57 55.3% 18 121
xml 2 19 28 59.6% 6 53
---------------- ----- --------- --------- --------- --------- ---------
Total 5 65 85 56.7% 24 174
====================================
./dubbo-demo
====================================
Examining 10 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 4 44 74 62.7% 15 133
xml 2 22 38 63.3% 14 74
---------------- ----- --------- --------- --------- --------- ---------
Total 6 66 112 62.9% 29 207
zsh: no matches found: **/src/test/
====================================
./dubbo-dependencies-bom
====================================
zsh: no matches found: **/src/main/
zsh: no matches found: **/src/test/
====================================
./dubbo-distribution
====================================
zsh: no matches found: **/src/main/
zsh: no matches found: **/src/test/
====================================
./dubbo-filter
====================================
Examining 24 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 20 846 449 34.7% 182 1477
---------------- ----- --------- --------- --------- --------- ---------
Total 20 846 449 34.7% 182 1477
Examining 11 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 11 365 176 32.5% 91 632
---------------- ----- --------- --------- --------- --------- ---------
Total 11 365 176 32.5% 91 632
====================================
./dubbo-metrics
====================================
Examining 14 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 14 609 629 50.8% 222 1460
---------------- ----- --------- --------- --------- --------- ---------
Total 14 609 629 50.8% 222 1460
Examining 2 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 2 129 32 19.9% 30 191
---------------- ----- --------- --------- --------- --------- ---------
Total 2 129 32 19.9% 30 191
====================================
./dubbo-monitor
====================================
Examining 10 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 8 582 197 25.3% 123 902
---------------- ----- --------- --------- --------- --------- ---------
Total 8 582 197 25.3% 123 902
Examining 6 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 6 525 108 17.1% 98 731
---------------- ----- --------- --------- --------- --------- ---------
Total 6 525 108 17.1% 98 731
====================================
./dubbo-plugin
====================================
Examining 30 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 28 1412 737 34.3% 371 2520
---------------- ----- --------- --------- --------- --------- ---------
Total 28 1412 737 34.3% 371 2520
Examining 24 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 22 728 352 32.6% 110 1190
---------------- ----- --------- --------- --------- --------- ---------
Total 22 728 352 32.6% 110 1190
====================================
./dubbo-registry
====================================
Examining 28 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 22 3418 758 18.2% 434 4610
---------------- ----- --------- --------- --------- --------- ---------
Total 22 3418 758 18.2% 434 4610
Examining 20 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 18 2680 637 19.2% 586 3903
xml 2 33 35 51.5% 4 72
---------------- ----- --------- --------- --------- --------- ---------
Total 20 2713 672 19.9% 590 3975
====================================
./dubbo-remoting
====================================
Examining 180 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 169 11153 4727 29.8% 2527 18407
---------------- ----- --------- --------- --------- --------- ---------
Total 169 11153 4727 29.8% 2527 18407
Examining 77 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 75 5448 1577 22.4% 1096 8121
xml 2 27 35 56.5% 4 66
---------------- ----- --------- --------- --------- --------- ---------
Total 77 5475 1612 22.7% 1100 8187
====================================
./dubbo-rpc
====================================
Examining 159 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 139 9642 3633 27.4% 1923 15198
---------------- ----- --------- --------- --------- --------- ---------
Total 139 9642 3633 27.4% 1923 15198
Examining 130 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 122 13662 3062 18.3% 3457 20181
xml 4 58 72 55.4% 19 149
---------------- ----- --------- --------- --------- --------- ---------
Total 126 13720 3134 18.6% 3476 20330
====================================
./dubbo-serialization
====================================
Examining 50 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 44 1752 953 35.2% 490 3195
---------------- ----- --------- --------- --------- --------- ---------
Total 44 1752 953 35.2% 490 3195
Examining 36 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 34 2872 578 16.8% 756 4206
xml 1 14 14 50.0% 2 30
---------------- ----- --------- --------- --------- --------- ---------
Total 35 2886 592 17.0% 758 4236
====================================
./dubbo-test
====================================
Examining 6 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 4 79 84 51.5% 37 200
xml 2 18 33 64.7% 11 62
---------------- ----- --------- --------- --------- --------- ---------
Total 6 97 117 54.7% 48 262
zsh: no matches found: **/src/test/
```
[ Full content available at: https://github.com/apache/incubator-dubbo/issues/2884 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org
[GitHub] [incubator-dubbo] oldratlee commented on issue #2884: We
need more code comments
Posted by "oldratlee (GitHub)" <gi...@apache.org>.
> @ralf0131
> @oldratlee Can you break it down by modules? We can start from the lowest.
```bash
$ for d in `find -mindepth 1 -maxdepth 1 -type d -name 'dubbo*'`; do (
echo
echo "===================================="
echo $d
echo "===================================="
cd $d
ohcount **/src/main/; ohcount **/src/test/
)
done
====================================
./dubbo-all
====================================
zsh: no matches found: **/src/main/
zsh: no matches found: **/src/test/
====================================
./dubbo-bom
====================================
zsh: no matches found: **/src/main/
zsh: no matches found: **/src/test/
====================================
./dubbo-cluster
====================================
Examining 67 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 62 2544 1400 35.5% 490 4434
---------------- ----- --------- --------- --------- --------- ---------
Total 62 2544 1400 35.5% 490 4434
Examining 38 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 34 3421 822 19.4% 706 4949
xml 1 13 14 51.9% 2 29
---------------- ----- --------- --------- --------- --------- ---------
Total 35 3434 836 19.6% 708 4978
====================================
./dubbo-common
====================================
Examining 121 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 115 15045 5248 25.9% 2610 22903
---------------- ----- --------- --------- --------- --------- ---------
Total 115 15045 5248 25.9% 2610 22903
Examining 183 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 158 8846 2671 23.2% 1899 13416
xml 1 14 18 56.2% 0 32
---------------- ----- --------- --------- --------- --------- ---------
Total 159 8860 2689 23.3% 1899 13448
====================================
./dubbo-compatible
====================================
Examining 78 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 78 2214 1493 40.3% 915 4622
---------------- ----- --------- --------- --------- --------- ---------
Total 78 2214 1493 40.3% 915 4622
Examining 31 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 30 1575 491 23.8% 369 2435
---------------- ----- --------- --------- --------- --------- ---------
Total 30 1575 491 23.8% 369 2435
====================================
./dubbo-config
====================================
Examining 64 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 58 6827 2373 25.8% 1826 11026
xmlschema 2 2563 0 0.0% 67 2630
---------------- ----- --------- --------- --------- --------- ---------
Total 60 9390 2373 20.2% 1893 13656
Examining 183 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 116 7112 2306 24.5% 1697 11115
xml 45 608 719 54.2% 311 1638
---------------- ----- --------- --------- --------- --------- ---------
Total 161 7720 3025 28.2% 2008 12753
====================================
./dubbo-container
====================================
Examining 14 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 5 244 112 31.5% 55 411
shell 5 240 6 2.4% 26 272
bat 1 22 1 4.3% 6 29
---------------- ----- --------- --------- --------- --------- ---------
Total 11 506 119 19.0% 87 712
Examining 5 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 3 46 57 55.3% 18 121
xml 2 19 28 59.6% 6 53
---------------- ----- --------- --------- --------- --------- ---------
Total 5 65 85 56.7% 24 174
====================================
./dubbo-demo
====================================
Examining 10 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 4 44 74 62.7% 15 133
xml 2 22 38 63.3% 14 74
---------------- ----- --------- --------- --------- --------- ---------
Total 6 66 112 62.9% 29 207
zsh: no matches found: **/src/test/
====================================
./dubbo-dependencies-bom
====================================
zsh: no matches found: **/src/main/
zsh: no matches found: **/src/test/
====================================
./dubbo-distribution
====================================
zsh: no matches found: **/src/main/
zsh: no matches found: **/src/test/
====================================
./dubbo-filter
====================================
Examining 24 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 20 846 449 34.7% 182 1477
---------------- ----- --------- --------- --------- --------- ---------
Total 20 846 449 34.7% 182 1477
Examining 11 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 11 365 176 32.5% 91 632
---------------- ----- --------- --------- --------- --------- ---------
Total 11 365 176 32.5% 91 632
====================================
./dubbo-metrics
====================================
Examining 14 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 14 609 629 50.8% 222 1460
---------------- ----- --------- --------- --------- --------- ---------
Total 14 609 629 50.8% 222 1460
Examining 2 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 2 129 32 19.9% 30 191
---------------- ----- --------- --------- --------- --------- ---------
Total 2 129 32 19.9% 30 191
====================================
./dubbo-monitor
====================================
Examining 10 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 8 582 197 25.3% 123 902
---------------- ----- --------- --------- --------- --------- ---------
Total 8 582 197 25.3% 123 902
Examining 6 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 6 525 108 17.1% 98 731
---------------- ----- --------- --------- --------- --------- ---------
Total 6 525 108 17.1% 98 731
====================================
./dubbo-plugin
====================================
Examining 30 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 28 1412 737 34.3% 371 2520
---------------- ----- --------- --------- --------- --------- ---------
Total 28 1412 737 34.3% 371 2520
Examining 24 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 22 728 352 32.6% 110 1190
---------------- ----- --------- --------- --------- --------- ---------
Total 22 728 352 32.6% 110 1190
====================================
./dubbo-registry
====================================
Examining 28 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 22 3418 758 18.2% 434 4610
---------------- ----- --------- --------- --------- --------- ---------
Total 22 3418 758 18.2% 434 4610
Examining 20 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 18 2680 637 19.2% 586 3903
xml 2 33 35 51.5% 4 72
---------------- ----- --------- --------- --------- --------- ---------
Total 20 2713 672 19.9% 590 3975
====================================
./dubbo-remoting
====================================
Examining 180 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 169 11153 4727 29.8% 2527 18407
---------------- ----- --------- --------- --------- --------- ---------
Total 169 11153 4727 29.8% 2527 18407
Examining 77 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 75 5448 1577 22.4% 1096 8121
xml 2 27 35 56.5% 4 66
---------------- ----- --------- --------- --------- --------- ---------
Total 77 5475 1612 22.7% 1100 8187
====================================
./dubbo-rpc
====================================
Examining 159 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 139 9642 3633 27.4% 1923 15198
---------------- ----- --------- --------- --------- --------- ---------
Total 139 9642 3633 27.4% 1923 15198
Examining 130 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 122 13662 3062 18.3% 3457 20181
xml 4 58 72 55.4% 19 149
---------------- ----- --------- --------- --------- --------- ---------
Total 126 13720 3134 18.6% 3476 20330
====================================
./dubbo-serialization
====================================
Examining 50 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 44 1752 953 35.2% 490 3195
---------------- ----- --------- --------- --------- --------- ---------
Total 44 1752 953 35.2% 490 3195
Examining 36 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 34 2872 578 16.8% 756 4206
xml 1 14 14 50.0% 2 30
---------------- ----- --------- --------- --------- --------- ---------
Total 35 2886 592 17.0% 758 4236
====================================
./dubbo-test
====================================
Examining 6 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 4 79 84 51.5% 37 200
xml 2 18 33 64.7% 11 62
---------------- ----- --------- --------- --------- --------- ---------
Total 6 97 117 54.7% 48 262
zsh: no matches found: **/src/test/
```
[ Full content available at: https://github.com/apache/incubator-dubbo/issues/2884 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org
[GitHub] [incubator-dubbo] oldratlee commented on issue #2884: We
need more code comments
Posted by "oldratlee (GitHub)" <gi...@apache.org>.
> @ralf0131
> @oldratlee Can you break it down by modules? We can start from the lowest.
Below is the quick-hack script to show coverage data per module:
```bash
$ for d in `find -mindepth 1 -maxdepth 1 -type d -name 'dubbo*'`; do (
echo
echo "===================================="
echo $d
echo "===================================="
cd $d
ohcount **/src/main/; ohcount **/src/test/
)
done
====================================
./dubbo-all
====================================
zsh: no matches found: **/src/main/
zsh: no matches found: **/src/test/
====================================
./dubbo-bom
====================================
zsh: no matches found: **/src/main/
zsh: no matches found: **/src/test/
====================================
./dubbo-cluster
====================================
Examining 67 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 62 2544 1400 35.5% 490 4434
---------------- ----- --------- --------- --------- --------- ---------
Total 62 2544 1400 35.5% 490 4434
Examining 38 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 34 3421 822 19.4% 706 4949
xml 1 13 14 51.9% 2 29
---------------- ----- --------- --------- --------- --------- ---------
Total 35 3434 836 19.6% 708 4978
====================================
./dubbo-common
====================================
Examining 121 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 115 15045 5248 25.9% 2610 22903
---------------- ----- --------- --------- --------- --------- ---------
Total 115 15045 5248 25.9% 2610 22903
Examining 183 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 158 8846 2671 23.2% 1899 13416
xml 1 14 18 56.2% 0 32
---------------- ----- --------- --------- --------- --------- ---------
Total 159 8860 2689 23.3% 1899 13448
====================================
./dubbo-compatible
====================================
Examining 78 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 78 2214 1493 40.3% 915 4622
---------------- ----- --------- --------- --------- --------- ---------
Total 78 2214 1493 40.3% 915 4622
Examining 31 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 30 1575 491 23.8% 369 2435
---------------- ----- --------- --------- --------- --------- ---------
Total 30 1575 491 23.8% 369 2435
====================================
./dubbo-config
====================================
Examining 64 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 58 6827 2373 25.8% 1826 11026
xmlschema 2 2563 0 0.0% 67 2630
---------------- ----- --------- --------- --------- --------- ---------
Total 60 9390 2373 20.2% 1893 13656
Examining 183 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 116 7112 2306 24.5% 1697 11115
xml 45 608 719 54.2% 311 1638
---------------- ----- --------- --------- --------- --------- ---------
Total 161 7720 3025 28.2% 2008 12753
====================================
./dubbo-container
====================================
Examining 14 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 5 244 112 31.5% 55 411
shell 5 240 6 2.4% 26 272
bat 1 22 1 4.3% 6 29
---------------- ----- --------- --------- --------- --------- ---------
Total 11 506 119 19.0% 87 712
Examining 5 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 3 46 57 55.3% 18 121
xml 2 19 28 59.6% 6 53
---------------- ----- --------- --------- --------- --------- ---------
Total 5 65 85 56.7% 24 174
====================================
./dubbo-demo
====================================
Examining 10 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 4 44 74 62.7% 15 133
xml 2 22 38 63.3% 14 74
---------------- ----- --------- --------- --------- --------- ---------
Total 6 66 112 62.9% 29 207
zsh: no matches found: **/src/test/
====================================
./dubbo-dependencies-bom
====================================
zsh: no matches found: **/src/main/
zsh: no matches found: **/src/test/
====================================
./dubbo-distribution
====================================
zsh: no matches found: **/src/main/
zsh: no matches found: **/src/test/
====================================
./dubbo-filter
====================================
Examining 24 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 20 846 449 34.7% 182 1477
---------------- ----- --------- --------- --------- --------- ---------
Total 20 846 449 34.7% 182 1477
Examining 11 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 11 365 176 32.5% 91 632
---------------- ----- --------- --------- --------- --------- ---------
Total 11 365 176 32.5% 91 632
====================================
./dubbo-metrics
====================================
Examining 14 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 14 609 629 50.8% 222 1460
---------------- ----- --------- --------- --------- --------- ---------
Total 14 609 629 50.8% 222 1460
Examining 2 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 2 129 32 19.9% 30 191
---------------- ----- --------- --------- --------- --------- ---------
Total 2 129 32 19.9% 30 191
====================================
./dubbo-monitor
====================================
Examining 10 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 8 582 197 25.3% 123 902
---------------- ----- --------- --------- --------- --------- ---------
Total 8 582 197 25.3% 123 902
Examining 6 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 6 525 108 17.1% 98 731
---------------- ----- --------- --------- --------- --------- ---------
Total 6 525 108 17.1% 98 731
====================================
./dubbo-plugin
====================================
Examining 30 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 28 1412 737 34.3% 371 2520
---------------- ----- --------- --------- --------- --------- ---------
Total 28 1412 737 34.3% 371 2520
Examining 24 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 22 728 352 32.6% 110 1190
---------------- ----- --------- --------- --------- --------- ---------
Total 22 728 352 32.6% 110 1190
====================================
./dubbo-registry
====================================
Examining 28 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 22 3418 758 18.2% 434 4610
---------------- ----- --------- --------- --------- --------- ---------
Total 22 3418 758 18.2% 434 4610
Examining 20 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 18 2680 637 19.2% 586 3903
xml 2 33 35 51.5% 4 72
---------------- ----- --------- --------- --------- --------- ---------
Total 20 2713 672 19.9% 590 3975
====================================
./dubbo-remoting
====================================
Examining 180 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 169 11153 4727 29.8% 2527 18407
---------------- ----- --------- --------- --------- --------- ---------
Total 169 11153 4727 29.8% 2527 18407
Examining 77 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 75 5448 1577 22.4% 1096 8121
xml 2 27 35 56.5% 4 66
---------------- ----- --------- --------- --------- --------- ---------
Total 77 5475 1612 22.7% 1100 8187
====================================
./dubbo-rpc
====================================
Examining 159 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 139 9642 3633 27.4% 1923 15198
---------------- ----- --------- --------- --------- --------- ---------
Total 139 9642 3633 27.4% 1923 15198
Examining 130 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 122 13662 3062 18.3% 3457 20181
xml 4 58 72 55.4% 19 149
---------------- ----- --------- --------- --------- --------- ---------
Total 126 13720 3134 18.6% 3476 20330
====================================
./dubbo-serialization
====================================
Examining 50 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 44 1752 953 35.2% 490 3195
---------------- ----- --------- --------- --------- --------- ---------
Total 44 1752 953 35.2% 490 3195
Examining 36 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 34 2872 578 16.8% 756 4206
xml 1 14 14 50.0% 2 30
---------------- ----- --------- --------- --------- --------- ---------
Total 35 2886 592 17.0% 758 4236
====================================
./dubbo-test
====================================
Examining 6 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 4 79 84 51.5% 37 200
xml 2 18 33 64.7% 11 62
---------------- ----- --------- --------- --------- --------- ---------
Total 6 97 117 54.7% 48 262
zsh: no matches found: **/src/test/
```
[ Full content available at: https://github.com/apache/incubator-dubbo/issues/2884 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org
[GitHub] [incubator-dubbo] oldratlee commented on issue #2884: We
need more code comments
Posted by "oldratlee (GitHub)" <gi...@apache.org>.
> @ralf0131
> @oldratlee Can you break it down by modules? We can start from the lowest.
comment coverage data per module sorted by product code:
module | product code | test code
------- | --------- | ----------
dubbo-registry | 18.2% | 19.2%
dubbo-monitor | 25.3% | 17.1%
dubbo-config | 25.8% | 24.5%
dubbo-common | 25.9% | 23.2%
dubbo-rpc | 27.4% | 18.3%
dubbo-remoting | 29.8% | 22.4%
dubbo-container | 31.5% | 55.3%
dubbo-plugin | 34.3% | 32.6%
dubbo-filter | 34.7% | 32.5%
dubbo-serialization | 35.2% | 16.8%
dubbo-cluster | 35.5% | 19.4%
dubbo-compatible | 40.3% | 23.8%
dubbo-metrics | 50.8% | 19.9%
dubbo-test | 51.5% | -
dubbo-demo | 62.7% | -
PS：
If needed, I can write a script to generate above table.
----------------------
Below is the quick-hack script to show coverage data per module:
```bash
$ for d in `find -mindepth 1 -maxdepth 1 -type d -name 'dubbo*'`; do (
echo
echo "===================================="
echo $d
echo "===================================="
cd $d
ohcount **/src/main/; ohcount **/src/test/
)
done
====================================
./dubbo-all
====================================
zsh: no matches found: **/src/main/
zsh: no matches found: **/src/test/
====================================
./dubbo-bom
====================================
zsh: no matches found: **/src/main/
zsh: no matches found: **/src/test/
====================================
./dubbo-cluster
====================================
Examining 67 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 62 2544 1400 35.5% 490 4434
---------------- ----- --------- --------- --------- --------- ---------
Total 62 2544 1400 35.5% 490 4434
Examining 38 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 34 3421 822 19.4% 706 4949
xml 1 13 14 51.9% 2 29
---------------- ----- --------- --------- --------- --------- ---------
Total 35 3434 836 19.6% 708 4978
====================================
./dubbo-common
====================================
Examining 121 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 115 15045 5248 25.9% 2610 22903
---------------- ----- --------- --------- --------- --------- ---------
Total 115 15045 5248 25.9% 2610 22903
Examining 183 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 158 8846 2671 23.2% 1899 13416
xml 1 14 18 56.2% 0 32
---------------- ----- --------- --------- --------- --------- ---------
Total 159 8860 2689 23.3% 1899 13448
====================================
./dubbo-compatible
====================================
Examining 78 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 78 2214 1493 40.3% 915 4622
---------------- ----- --------- --------- --------- --------- ---------
Total 78 2214 1493 40.3% 915 4622
Examining 31 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 30 1575 491 23.8% 369 2435
---------------- ----- --------- --------- --------- --------- ---------
Total 30 1575 491 23.8% 369 2435
====================================
./dubbo-config
====================================
Examining 64 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 58 6827 2373 25.8% 1826 11026
xmlschema 2 2563 0 0.0% 67 2630
---------------- ----- --------- --------- --------- --------- ---------
Total 60 9390 2373 20.2% 1893 13656
Examining 183 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 116 7112 2306 24.5% 1697 11115
xml 45 608 719 54.2% 311 1638
---------------- ----- --------- --------- --------- --------- ---------
Total 161 7720 3025 28.2% 2008 12753
====================================
./dubbo-container
====================================
Examining 14 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 5 244 112 31.5% 55 411
shell 5 240 6 2.4% 26 272
bat 1 22 1 4.3% 6 29
---------------- ----- --------- --------- --------- --------- ---------
Total 11 506 119 19.0% 87 712
Examining 5 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 3 46 57 55.3% 18 121
xml 2 19 28 59.6% 6 53
---------------- ----- --------- --------- --------- --------- ---------
Total 5 65 85 56.7% 24 174
====================================
./dubbo-demo
====================================
Examining 10 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 4 44 74 62.7% 15 133
xml 2 22 38 63.3% 14 74
---------------- ----- --------- --------- --------- --------- ---------
Total 6 66 112 62.9% 29 207
zsh: no matches found: **/src/test/
====================================
./dubbo-dependencies-bom
====================================
zsh: no matches found: **/src/main/
zsh: no matches found: **/src/test/
====================================
./dubbo-distribution
====================================
zsh: no matches found: **/src/main/
zsh: no matches found: **/src/test/
====================================
./dubbo-filter
====================================
Examining 24 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 20 846 449 34.7% 182 1477
---------------- ----- --------- --------- --------- --------- ---------
Total 20 846 449 34.7% 182 1477
Examining 11 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 11 365 176 32.5% 91 632
---------------- ----- --------- --------- --------- --------- ---------
Total 11 365 176 32.5% 91 632
====================================
./dubbo-metrics
====================================
Examining 14 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 14 609 629 50.8% 222 1460
---------------- ----- --------- --------- --------- --------- ---------
Total 14 609 629 50.8% 222 1460
Examining 2 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 2 129 32 19.9% 30 191
---------------- ----- --------- --------- --------- --------- ---------
Total 2 129 32 19.9% 30 191
====================================
./dubbo-monitor
====================================
Examining 10 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 8 582 197 25.3% 123 902
---------------- ----- --------- --------- --------- --------- ---------
Total 8 582 197 25.3% 123 902
Examining 6 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 6 525 108 17.1% 98 731
---------------- ----- --------- --------- --------- --------- ---------
Total 6 525 108 17.1% 98 731
====================================
./dubbo-plugin
====================================
Examining 30 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 28 1412 737 34.3% 371 2520
---------------- ----- --------- --------- --------- --------- ---------
Total 28 1412 737 34.3% 371 2520
Examining 24 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 22 728 352 32.6% 110 1190
---------------- ----- --------- --------- --------- --------- ---------
Total 22 728 352 32.6% 110 1190
====================================
./dubbo-registry
====================================
Examining 28 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 22 3418 758 18.2% 434 4610
---------------- ----- --------- --------- --------- --------- ---------
Total 22 3418 758 18.2% 434 4610
Examining 20 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 18 2680 637 19.2% 586 3903
xml 2 33 35 51.5% 4 72
---------------- ----- --------- --------- --------- --------- ---------
Total 20 2713 672 19.9% 590 3975
====================================
./dubbo-remoting
====================================
Examining 180 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 169 11153 4727 29.8% 2527 18407
---------------- ----- --------- --------- --------- --------- ---------
Total 169 11153 4727 29.8% 2527 18407
Examining 77 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 75 5448 1577 22.4% 1096 8121
xml 2 27 35 56.5% 4 66
---------------- ----- --------- --------- --------- --------- ---------
Total 77 5475 1612 22.7% 1100 8187
====================================
./dubbo-rpc
====================================
Examining 159 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 139 9642 3633 27.4% 1923 15198
---------------- ----- --------- --------- --------- --------- ---------
Total 139 9642 3633 27.4% 1923 15198
Examining 130 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 122 13662 3062 18.3% 3457 20181
xml 4 58 72 55.4% 19 149
---------------- ----- --------- --------- --------- --------- ---------
Total 126 13720 3134 18.6% 3476 20330
====================================
./dubbo-serialization
====================================
Examining 50 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 44 1752 953 35.2% 490 3195
---------------- ----- --------- --------- --------- --------- ---------
Total 44 1752 953 35.2% 490 3195
Examining 36 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 34 2872 578 16.8% 756 4206
xml 1 14 14 50.0% 2 30
---------------- ----- --------- --------- --------- --------- ---------
Total 35 2886 592 17.0% 758 4236
====================================
./dubbo-test
====================================
Examining 6 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 4 79 84 51.5% 37 200
xml 2 18 33 64.7% 11 62
---------------- ----- --------- --------- --------- --------- ---------
Total 6 97 117 54.7% 48 262
zsh: no matches found: **/src/test/
```
[ Full content available at: https://github.com/apache/incubator-dubbo/issues/2884 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org
[GitHub] [incubator-dubbo] oldratlee commented on issue #2884: We
need more code comments
Posted by "oldratlee (GitHub)" <gi...@apache.org>.
comment coverage report of 1f751a602654f52d1ea86488a66d56c2a8faced6 generated by below script: @ralf0131
NO. | module | product code | test code
--- | ------ | ------------ | ---------
1 | dubbo-demo-api | 0.0% (0/3) | -
2 | dubbo-serialization-fastjson | 0.0% (0/179) | -
3 | dubbo-serialization-fst | 0.0% (0/192) | -
4 | dubbo-serialization-protostuff | 1.0% (3/305) | -
5 | dubbo-rpc-http | 1.6% (3/184) | 4.3% (9/199)
6 | dubbo-registry-redis | 1.7% (10/572) | 0.0% (0/80)
7 | dubbo-rpc-redis | 1.9% (3/151) | 1.7% (3/175)
8 | dubbo-remoting-zookeeper | 2.4% (12/479) | 0.0% (0/264)
9 | dubbo-rpc-webservice | 2.4% (3/122) | 12.8% (16/109)
10 | dubbo-registry-zookeeper | 2.9% (8/268) | 3.3% (4/117)
11 | dubbo-serialization-jdk | 3.1% (12/376) | -
12 | dubbo-rpc-memcached | 3.2% (3/92) | 0.0% (0/2)
13 | dubbo-rpc-hessian | 3.4% (9/257) | 3.8% (9/225)
14 | dubbo-serialization-hessian2 | 3.7% (6/157) | -
15 | dubbo-registry-multicast | 3.8% (15/382) | 23.3% (44/145)
16 | dubbo-remoting-mina | 4.0% (23/549) | 20.2% (34/134)
17 | dubbo-container-log4j | 4.2% (3/69) | 21.4% (3/11)
18 | dubbo-monitor-default | 4.6% (17/354) | 1.9% (6/313)
19 | dubbo-remoting-netty | 4.9% (52/1007) | 11.1% (68/544)
20 | dubbo-remoting-grizzly | 5.1% (27/506) | -
21 | dubbo-rpc-dubbo | 6.0% (173/2716) | 5.3% (111/1969)
22 | dubbo-rpc-rest | 7.3% (58/738) | 3.6% (11/294)
23 | dubbo-rpc-thrift | 7.5% (93/1149) | 8.2% (677/7596)
24 | dubbo-serialization-kryo | 7.5% (34/422) | -
25 | dubbo-container-spring | 7.9% (3/35) | 18.8% (3/13)
26 | dubbo-filter-validation | 8.6% (33/349) | 0.0% (0/158)
27 | dubbo-rpc-injvm | 10.1% (15/133) | 6.1% (12/185)
28 | dubbo-compatible | 10.3% (245/2136) | 0.7% (11/1545)
29 | dubbo-rpc-rmi | 10.6% (13/110) | 34.2% (80/154)
30 | dubbo-registry-default | 11.4% (23/178) | 10.1% (172/1529)
31 | dubbo-remoting-p2p | 12.1% (117/852) | 0.0% (0/152)
32 | dubbo-remoting-netty4 | 12.2% (168/1213) | 7.6% (20/242)
33 | dubbo-container-api | 13.5% (12/77) | -
34 | dubbo-cluster | 14.1% (408/2482) | 7.6% (278/3387)
35 | dubbo-registry-api | 14.9% (350/1996) | 14.0% (129/791)
36 | dubbo-config-api | 16.1% (762/3962) | 4.9% (212/4103)
37 | dubbo-filter-cache | 16.8% (96/477) | 0.0% (0/196)
38 | dubbo-qos | 17.3% (289/1384) | 0.0% (0/706)
39 | dubbo-common | 18.6% (3414/14930) | 1.8% (159/8688)
40 | dubbo-monitor-api | 19.1% (52/220) | 2.8% (6/206)
41 | dubbo-container-logback | 19.4% (14/58) | 13.6% (3/19)
42 | dubbo-config-spring | 19.6% (683/2807) | 7.6% (238/2893)
43 | dubbo-remoting-api | 20.3% (1545/6054) | 6.0% (255/3979)
44 | dubbo-remoting-http | 20.5% (79/306) | 0.0% (0/58)
45 | dubbo-demo-provider | 20.8% (5/19) | -
46 | dubbo-test-spring3 | 21.1% (20/75) | -
47 | dubbo-rpc-api | 21.2% (1036/3851) | 4.7% (76/1551)
48 | dubbo-demo-consumer | 21.7% (5/18) | -
49 | dubbo-metrics-api | 40.5% (405/595) | 0.0% (0/127)
50 | dubbo-serialization-api | 71.6% (194/77) | -
--------------
`comment-coverage-report.sh`:
https://gist.github.com/oldratlee/6d02a849b8b84a9aba26be7ee65f5560
[ Full content available at: https://github.com/apache/incubator-dubbo/issues/2884 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org
[GitHub] [incubator-dubbo] oldratlee commented on issue #2884: We
need more code comments
Posted by "oldratlee (GitHub)" <gi...@apache.org>.
> @ralf0131
> @oldratlee Can you break it down by modules? We can start from the lowest.
```bash
$ for d in `find -mindepth 1 -maxdepth 1 -type d -name 'dubbo*'`; do (
echo
echo ====================================
echo $d
echo ====================================
cd $d
ohcount **/src/main/; ohcount **/src/test/
)
done
====================================
./dubbo-all
====================================
zsh: no matches found: **/src/main/
zsh: no matches found: **/src/test/
====================================
./dubbo-bom
====================================
zsh: no matches found: **/src/main/
zsh: no matches found: **/src/test/
====================================
./dubbo-cluster
====================================
Examining 67 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 62 2544 1400 35.5% 490 4434
---------------- ----- --------- --------- --------- --------- ---------
Total 62 2544 1400 35.5% 490 4434
Examining 38 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 34 3421 822 19.4% 706 4949
xml 1 13 14 51.9% 2 29
---------------- ----- --------- --------- --------- --------- ---------
Total 35 3434 836 19.6% 708 4978
====================================
./dubbo-common
====================================
Examining 121 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 115 15045 5248 25.9% 2610 22903
---------------- ----- --------- --------- --------- --------- ---------
Total 115 15045 5248 25.9% 2610 22903
Examining 183 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 158 8846 2671 23.2% 1899 13416
xml 1 14 18 56.2% 0 32
---------------- ----- --------- --------- --------- --------- ---------
Total 159 8860 2689 23.3% 1899 13448
====================================
./dubbo-compatible
====================================
Examining 78 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 78 2214 1493 40.3% 915 4622
---------------- ----- --------- --------- --------- --------- ---------
Total 78 2214 1493 40.3% 915 4622
Examining 31 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 30 1575 491 23.8% 369 2435
---------------- ----- --------- --------- --------- --------- ---------
Total 30 1575 491 23.8% 369 2435
====================================
./dubbo-config
====================================
Examining 64 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 58 6827 2373 25.8% 1826 11026
xmlschema 2 2563 0 0.0% 67 2630
---------------- ----- --------- --------- --------- --------- ---------
Total 60 9390 2373 20.2% 1893 13656
Examining 183 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 116 7112 2306 24.5% 1697 11115
xml 45 608 719 54.2% 311 1638
---------------- ----- --------- --------- --------- --------- ---------
Total 161 7720 3025 28.2% 2008 12753
====================================
./dubbo-container
====================================
Examining 14 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 5 244 112 31.5% 55 411
shell 5 240 6 2.4% 26 272
bat 1 22 1 4.3% 6 29
---------------- ----- --------- --------- --------- --------- ---------
Total 11 506 119 19.0% 87 712
Examining 5 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 3 46 57 55.3% 18 121
xml 2 19 28 59.6% 6 53
---------------- ----- --------- --------- --------- --------- ---------
Total 5 65 85 56.7% 24 174
====================================
./dubbo-demo
====================================
Examining 10 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 4 44 74 62.7% 15 133
xml 2 22 38 63.3% 14 74
---------------- ----- --------- --------- --------- --------- ---------
Total 6 66 112 62.9% 29 207
zsh: no matches found: **/src/test/
====================================
./dubbo-dependencies-bom
====================================
zsh: no matches found: **/src/main/
zsh: no matches found: **/src/test/
====================================
./dubbo-distribution
====================================
zsh: no matches found: **/src/main/
zsh: no matches found: **/src/test/
====================================
./dubbo-filter
====================================
Examining 24 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 20 846 449 34.7% 182 1477
---------------- ----- --------- --------- --------- --------- ---------
Total 20 846 449 34.7% 182 1477
Examining 11 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 11 365 176 32.5% 91 632
---------------- ----- --------- --------- --------- --------- ---------
Total 11 365 176 32.5% 91 632
====================================
./dubbo-metrics
====================================
Examining 14 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 14 609 629 50.8% 222 1460
---------------- ----- --------- --------- --------- --------- ---------
Total 14 609 629 50.8% 222 1460
Examining 2 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 2 129 32 19.9% 30 191
---------------- ----- --------- --------- --------- --------- ---------
Total 2 129 32 19.9% 30 191
====================================
./dubbo-monitor
====================================
Examining 10 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 8 582 197 25.3% 123 902
---------------- ----- --------- --------- --------- --------- ---------
Total 8 582 197 25.3% 123 902
Examining 6 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 6 525 108 17.1% 98 731
---------------- ----- --------- --------- --------- --------- ---------
Total 6 525 108 17.1% 98 731
====================================
./dubbo-plugin
====================================
Examining 30 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 28 1412 737 34.3% 371 2520
---------------- ----- --------- --------- --------- --------- ---------
Total 28 1412 737 34.3% 371 2520
Examining 24 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 22 728 352 32.6% 110 1190
---------------- ----- --------- --------- --------- --------- ---------
Total 22 728 352 32.6% 110 1190
====================================
./dubbo-registry
====================================
Examining 28 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 22 3418 758 18.2% 434 4610
---------------- ----- --------- --------- --------- --------- ---------
Total 22 3418 758 18.2% 434 4610
Examining 20 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 18 2680 637 19.2% 586 3903
xml 2 33 35 51.5% 4 72
---------------- ----- --------- --------- --------- --------- ---------
Total 20 2713 672 19.9% 590 3975
====================================
./dubbo-remoting
====================================
Examining 180 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 169 11153 4727 29.8% 2527 18407
---------------- ----- --------- --------- --------- --------- ---------
Total 169 11153 4727 29.8% 2527 18407
Examining 77 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 75 5448 1577 22.4% 1096 8121
xml 2 27 35 56.5% 4 66
---------------- ----- --------- --------- --------- --------- ---------
Total 77 5475 1612 22.7% 1100 8187
====================================
./dubbo-rpc
====================================
Examining 159 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 139 9642 3633 27.4% 1923 15198
---------------- ----- --------- --------- --------- --------- ---------
Total 139 9642 3633 27.4% 1923 15198
Examining 130 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 122 13662 3062 18.3% 3457 20181
xml 4 58 72 55.4% 19 149
---------------- ----- --------- --------- --------- --------- ---------
Total 126 13720 3134 18.6% 3476 20330
====================================
./dubbo-serialization
====================================
Examining 50 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 44 1752 953 35.2% 490 3195
---------------- ----- --------- --------- --------- --------- ---------
Total 44 1752 953 35.2% 490 3195
Examining 36 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 34 2872 578 16.8% 756 4206
xml 1 14 14 50.0% 2 30
---------------- ----- --------- --------- --------- --------- ---------
Total 35 2886 592 17.0% 758 4236
====================================
./dubbo-test
====================================
Examining 6 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 4 79 84 51.5% 37 200
xml 2 18 33 64.7% 11 62
---------------- ----- --------- --------- --------- --------- ---------
Total 6 97 117 54.7% 48 262
zsh: no matches found: **/src/test/
```
[ Full content available at: https://github.com/apache/incubator-dubbo/issues/2884 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org
[GitHub] [incubator-dubbo] khanimteyaz commented on issue #2884: We
need more code comments
Posted by "khanimteyaz (GitHub)" <gi...@apache.org>.
How can I create the card under this project and assigned it to me, so that it can be easier for reported to track.
[ Full content available at: https://github.com/apache/incubator-dubbo/issues/2884 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org
[GitHub] [incubator-dubbo] oldratlee commented on issue #2884: We
need more code comments
Posted by "oldratlee (GitHub)" <gi...@apache.org>.
> @lovepoem
>
> @oldratlee，can we statistics the comment coverage as test coverage in the codecov.io ?
I have found comment coverage info in the codecov.io yet.
[ Full content available at: https://github.com/apache/incubator-dubbo/issues/2884 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org
[GitHub] [incubator-dubbo] oldratlee commented on issue #2884: We
need more code comments
Posted by "oldratlee (GitHub)" <gi...@apache.org>.
> @ralf0131
> @oldratlee Can you break it down by modules? We can start from the lowest.
```bash
$ for d in `echo dubbo*`; do (echo -e "\n====================================\n$d\n====================================";
====================================
dubbo-all
====================================
zsh: no matches found: **/src/main/
zsh: no matches found: **/src/test/
====================================
dubbo-bom
====================================
zsh: no matches found: **/src/main/
zsh: no matches found: **/src/test/
====================================
dubbo-cluster
====================================
Examining 67 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 62 2544 1400 35.5% 490 4434
---------------- ----- --------- --------- --------- --------- ---------
Total 62 2544 1400 35.5% 490 4434
Examining 38 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 34 3421 822 19.4% 706 4949
xml 1 13 14 51.9% 2 29
---------------- ----- --------- --------- --------- --------- ---------
Total 35 3434 836 19.6% 708 4978
====================================
dubbo-common
====================================
Examining 121 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 115 15045 5248 25.9% 2610 22903
---------------- ----- --------- --------- --------- --------- ---------
Total 115 15045 5248 25.9% 2610 22903
Examining 183 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 158 8846 2671 23.2% 1899 13416
xml 1 14 18 56.2% 0 32
---------------- ----- --------- --------- --------- --------- ---------
Total 159 8860 2689 23.3% 1899 13448
====================================
dubbo-compatible
====================================
Examining 78 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 78 2214 1493 40.3% 915 4622
---------------- ----- --------- --------- --------- --------- ---------
Total 78 2214 1493 40.3% 915 4622
Examining 31 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 30 1575 491 23.8% 369 2435
---------------- ----- --------- --------- --------- --------- ---------
Total 30 1575 491 23.8% 369 2435
====================================
dubbo-config
====================================
Examining 64 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 58 6827 2373 25.8% 1826 11026
xmlschema 2 2563 0 0.0% 67 2630
---------------- ----- --------- --------- --------- --------- ---------
Total 60 9390 2373 20.2% 1893 13656
Examining 183 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 116 7112 2306 24.5% 1697 11115
xml 45 608 719 54.2% 311 1638
---------------- ----- --------- --------- --------- --------- ---------
Total 161 7720 3025 28.2% 2008 12753
====================================
dubbo-container
====================================
Examining 14 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 5 244 112 31.5% 55 411
shell 5 240 6 2.4% 26 272
bat 1 22 1 4.3% 6 29
---------------- ----- --------- --------- --------- --------- ---------
Total 11 506 119 19.0% 87 712
Examining 5 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 3 46 57 55.3% 18 121
xml 2 19 28 59.6% 6 53
---------------- ----- --------- --------- --------- --------- ---------
Total 5 65 85 56.7% 24 174
====================================
dubbo-demo
====================================
Examining 10 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 4 44 74 62.7% 15 133
xml 2 22 38 63.3% 14 74
---------------- ----- --------- --------- --------- --------- ---------
Total 6 66 112 62.9% 29 207
zsh: no matches found: **/src/test/
====================================
dubbo-dependencies-bom
====================================
zsh: no matches found: **/src/main/
zsh: no matches found: **/src/test/
====================================
dubbo-distribution
====================================
zsh: no matches found: **/src/main/
zsh: no matches found: **/src/test/
====================================
dubbo-filter
====================================
Examining 24 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 20 846 449 34.7% 182 1477
---------------- ----- --------- --------- --------- --------- ---------
Total 20 846 449 34.7% 182 1477
Examining 11 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 11 365 176 32.5% 91 632
---------------- ----- --------- --------- --------- --------- ---------
Total 11 365 176 32.5% 91 632
====================================
dubbo-metrics
====================================
Examining 14 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 14 609 629 50.8% 222 1460
---------------- ----- --------- --------- --------- --------- ---------
Total 14 609 629 50.8% 222 1460
Examining 2 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 2 129 32 19.9% 30 191
---------------- ----- --------- --------- --------- --------- ---------
Total 2 129 32 19.9% 30 191
====================================
dubbo-monitor
====================================
Examining 10 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 8 582 197 25.3% 123 902
---------------- ----- --------- --------- --------- --------- ---------
Total 8 582 197 25.3% 123 902
Examining 6 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 6 525 108 17.1% 98 731
---------------- ----- --------- --------- --------- --------- ---------
Total 6 525 108 17.1% 98 731
====================================
dubbo-plugin
====================================
Examining 30 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 28 1412 737 34.3% 371 2520
---------------- ----- --------- --------- --------- --------- ---------
Total 28 1412 737 34.3% 371 2520
Examining 24 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 22 728 352 32.6% 110 1190
---------------- ----- --------- --------- --------- --------- ---------
Total 22 728 352 32.6% 110 1190
====================================
dubbo-registry
====================================
Examining 28 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 22 3418 758 18.2% 434 4610
---------------- ----- --------- --------- --------- --------- ---------
Total 22 3418 758 18.2% 434 4610
Examining 20 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 18 2680 637 19.2% 586 3903
xml 2 33 35 51.5% 4 72
---------------- ----- --------- --------- --------- --------- ---------
Total 20 2713 672 19.9% 590 3975
====================================
dubbo-remoting
====================================
Examining 180 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 169 11153 4727 29.8% 2527 18407
---------------- ----- --------- --------- --------- --------- ---------
Total 169 11153 4727 29.8% 2527 18407
Examining 77 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 75 5448 1577 22.4% 1096 8121
xml 2 27 35 56.5% 4 66
---------------- ----- --------- --------- --------- --------- ---------
Total 77 5475 1612 22.7% 1100 8187
====================================
dubbo-rpc
====================================
Examining 159 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 139 9642 3633 27.4% 1923 15198
---------------- ----- --------- --------- --------- --------- ---------
Total 139 9642 3633 27.4% 1923 15198
Examining 130 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 122 13662 3062 18.3% 3457 20181
xml 4 58 72 55.4% 19 149
---------------- ----- --------- --------- --------- --------- ---------
Total 126 13720 3134 18.6% 3476 20330
====================================
dubbo-serialization
====================================
Examining 50 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 44 1752 953 35.2% 490 3195
---------------- ----- --------- --------- --------- --------- ---------
Total 44 1752 953 35.2% 490 3195
Examining 36 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 34 2872 578 16.8% 756 4206
xml 1 14 14 50.0% 2 30
---------------- ----- --------- --------- --------- --------- ---------
Total 35 2886 592 17.0% 758 4236
====================================
dubbo-test
====================================
Examining 6 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 4 79 84 51.5% 37 200
xml 2 18 33 64.7% 11 62
---------------- ----- --------- --------- --------- --------- ---------
Total 6 97 117 54.7% 48 262
zsh: no matches found: **/src/test/
```
[ Full content available at: https://github.com/apache/incubator-dubbo/issues/2884 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org
[GitHub] [incubator-dubbo] ralf0131 commented on issue #2884: We need
more code comments
Posted by "ralf0131 (GitHub)" <gi...@apache.org>.
@oldratlee Can you break it down by modules? We can start from the lowest.
[ Full content available at: https://github.com/apache/incubator-dubbo/issues/2884 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org
[GitHub] [incubator-dubbo] khanimteyaz commented on issue #2884: We
need more code comments
Posted by "khanimteyaz (GitHub)" <gi...@apache.org>.
@carryxyh
Thanks for the greeting. I would do that.
[ Full content available at: https://github.com/apache/incubator-dubbo/issues/2884 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org
[GitHub] [incubator-dubbo] oldratlee commented on issue #2884: We
need more code comments
Posted by "oldratlee (GitHub)" <gi...@apache.org>.
comment coverage report generated by blow scripts:
module | product code | test code
------ | ------------ | ---------
dubbo-registry-redis | 6.8% | 16.5%
dubbo-registry-multicast | 10.9% | 34.1%
dubbo-rpc-redis | 11.1% | 16.5%
dubbo-registry-zookeeper | 12.9% | 14.5%
dubbo-rpc-webservice | 13.4% | 41.5%
dubbo-monitor-default | 15.4% | 18.1%
dubbo-rpc-http | 15.8% | 22.0%
dubbo-remoting-netty | 16.2% | 34.4%
dubbo-rpc-dubbo | 16.9% | 21.4%
dubbo-rpc-memcached | 17.0% | 84.2%
dubbo-remoting-mina | 17.7% | 48.1%
dubbo-remoting-grizzly | 19.4% | -
dubbo-rpc-thrift | 20.6% | 11.3%
dubbo-serialization-fastjson | 20.9% | -
dubbo-remoting-netty4 | 21.1% | 37.2%
dubbo-container-log4j | 21.3% | 61.3%
dubbo-config-api | 21.9% | 22.9%
dubbo-rpc-hessian | 21.9% | 20.0%
dubbo-registry-api | 22.2% | 20.8%
dubbo-registry-default | 23.4% | 17.0%
dubbo-serialization-protostuff | 24.1% | -
dubbo-serialization-fst | 24.6% | -
dubbo-common | 25.9% | 23.2%
dubbo-remoting-zookeeper | 26.0% | 22.9%
dubbo-rpc-rest | 28.4% | 33.8%
dubbo-rpc-rmi | 28.7% | 52.4%
dubbo-serialization-jdk | 28.8% | -
dubbo-filter-validation | 28.9% | 32.9%
dubbo-serialization-hessian2 | 30.3% | -
dubbo-config-spring | 30.7% | 26.7%
dubbo-serialization-kryo | 31.0% | -
dubbo-rpc-injvm | 31.7% | 39.2%
dubbo-remoting-api | 33.2% | 17.4%
dubbo-remoting-p2p | 33.4% | 23.6%
dubbo-container-logback | 33.7% | 48.7%
dubbo-qos | 34.3% | 32.6%
dubbo-container-spring | 34.5% | 57.6%
dubbo-cluster | 35.5% | 19.4%
dubbo-container-api | 35.8% | -
dubbo-rpc-api | 36.0% | 31.0%
dubbo-monitor-api | 37.0% | 15.4%
dubbo-filter-cache | 38.3% | 32.2%
dubbo-compatible | 40.3% | 23.8%
dubbo-remoting-http | 47.4% | 34.8%
dubbo-metrics-api | 50.8% | 19.9%
dubbo-test-spring3 | 51.5% | -
dubbo-demo-consumer | 52.5% | -
dubbo-demo-provider | 63.8% | -
dubbo-serialization-api | 79.1% | -
dubbo-demo-api | 80.0% | -
--------------
```bash
#!/bin/bash
# comment-coverage-report.sh
# generate comment coverage report, markdown table format
#
# NOTE:
# 1. run at project root dir
# 2. install ohcount: https://github.com/blackducksw/ohcount
# if you use mac install by brew: brew install ohcount
getCommentCoverage() {
local dir="$1"
local comment_coverage="$(ohcount "$dir" | awk '/^java /{print $5}')"
comment_coverage="${comment_coverage:--}"
echo "$comment_coverage"
}
getCommentCoveragePerModule() {
local pom
for pom in `find -name pom.xml`; do
local module_dir="$(dirname "$pom")"
local module_name="$(basename "$module_dir")"
local module_product_code_dir="$module_dir/src/main/java"
local module_test_code_dir="$module_dir/src/test/java"
[ ! -d "$module_product_code_dir" ] && continue
echo "$(basename "$module_name") | $(getCommentCoverage "$module_product_code_dir") | $(getCommentCoverage "$module_test_code_dir")"
done
}
genCommentCoverageReport() {
# output table header
echo "module | product code | test code"
echo "------ | ------------ | ---------"
# output table body
getCommentCoveragePerModule | sort '-t|' -n -k2
}
genCommentCoverageReport
```
[ Full content available at: https://github.com/apache/incubator-dubbo/issues/2884 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org
[GitHub] [incubator-dubbo] oldratlee commented on issue #2884: We
need more code comments
Posted by "oldratlee (GitHub)" <gi...@apache.org>.
comment coverage report for https://github.com/apache/incubator-dubbo/commit/1f751a602654f52d1ea86488a66d56c2a8faced6 :
module | product code | test code
------ | ------------ | ---------
dubbo-demo-api | 0.0% (0/3) | -
dubbo-serialization-fastjson | 0.0% (0/179) | -
dubbo-serialization-fst | 0.0% (0/192) | -
dubbo-serialization-protostuff | 1.0% (3/305) | -
dubbo-rpc-http | 1.6% (3/184) | 4.3% (9/199)
dubbo-registry-redis | 1.7% (10/572) | 0.0% (0/80)
dubbo-rpc-redis | 1.9% (3/151) | 1.7% (3/175)
dubbo-remoting-zookeeper | 2.4% (12/479) | 0.0% (0/264)
dubbo-rpc-webservice | 2.4% (3/122) | 12.8% (16/109)
dubbo-registry-zookeeper | 2.9% (8/268) | 3.3% (4/117)
dubbo-serialization-jdk | 3.1% (12/376) | -
dubbo-rpc-memcached | 3.2% (3/92) | 0.0% (0/2)
dubbo-rpc-hessian | 3.4% (9/257) | 3.8% (9/225)
dubbo-serialization-hessian2 | 3.7% (6/157) | -
dubbo-registry-multicast | 3.8% (15/382) | 23.3% (44/145)
dubbo-remoting-mina | 4.0% (23/549) | 20.2% (34/134)
dubbo-container-log4j | 4.2% (3/69) | 21.4% (3/11)
dubbo-monitor-default | 4.6% (17/354) | 1.9% (6/313)
dubbo-remoting-netty | 4.9% (52/1007) | 11.1% (68/544)
dubbo-remoting-grizzly | 5.1% (27/506) | -
dubbo-rpc-dubbo | 6.0% (173/2716) | 5.3% (111/1969)
dubbo-rpc-rest | 7.3% (58/738) | 3.6% (11/294)
dubbo-rpc-thrift | 7.5% (93/1149) | 8.2% (677/7596)
dubbo-serialization-kryo | 7.5% (34/422) | -
dubbo-container-spring | 7.9% (3/35) | 18.8% (3/13)
dubbo-filter-validation | 8.6% (33/349) | 0.0% (0/158)
dubbo-rpc-injvm | 10.1% (15/133) | 6.1% (12/185)
dubbo-compatible | 10.3% (245/2136) | 0.7% (11/1545)
dubbo-rpc-rmi | 10.6% (13/110) | 34.2% (80/154)
dubbo-registry-default | 11.4% (23/178) | 10.1% (172/1529)
dubbo-remoting-p2p | 12.1% (117/852) | 0.0% (0/152)
dubbo-remoting-netty4 | 12.2% (168/1213) | 7.6% (20/242)
dubbo-container-api | 13.5% (12/77) | -
dubbo-cluster | 14.1% (408/2482) | 7.6% (278/3387)
dubbo-registry-api | 14.9% (350/1996) | 14.0% (129/791)
dubbo-config-api | 16.1% (762/3962) | 4.9% (212/4103)
dubbo-filter-cache | 16.8% (96/477) | 0.0% (0/196)
dubbo-qos | 17.3% (289/1384) | 0.0% (0/706)
dubbo-common | 18.6% (3414/14930) | 1.8% (159/8688)
dubbo-monitor-api | 19.1% (52/220) | 2.8% (6/206)
dubbo-container-logback | 19.4% (14/58) | 13.6% (3/19)
dubbo-config-spring | 19.6% (683/2807) | 7.6% (238/2893)
dubbo-remoting-api | 20.3% (1545/6054) | 6.0% (255/3979)
dubbo-remoting-http | 20.5% (79/306) | 0.0% (0/58)
dubbo-demo-provider | 20.8% (5/19) | -
dubbo-test-spring3 | 21.1% (20/75) | -
dubbo-rpc-api | 21.2% (1036/3851) | 4.7% (76/1551)
dubbo-demo-consumer | 21.7% (5/18) | -
dubbo-metrics-api | 40.5% (405/595) | 0.0% (0/127)
dubbo-serialization-api | 71.6% (194/77) | -
--------------
`comment-coverage-report.sh`: https://gist.github.com/oldratlee/6d02a849b8b84a9aba26be7ee65f5560
[ Full content available at: https://github.com/apache/incubator-dubbo/issues/2884 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org
[GitHub] [incubator-dubbo] oldratlee commented on issue #2884: We
need more code comments
Posted by "oldratlee (GitHub)" <gi...@apache.org>.
comment coverage report generated by below scripts: ☺️
module | product code | test code
------ | ------------ | ---------
dubbo-registry-redis | 6.8% | 16.5%
dubbo-registry-multicast | 10.9% | 34.1%
dubbo-rpc-redis | 11.1% | 16.5%
dubbo-registry-zookeeper | 12.9% | 14.5%
dubbo-rpc-webservice | 13.4% | 41.5%
dubbo-monitor-default | 15.4% | 18.1%
dubbo-rpc-http | 15.8% | 22.0%
dubbo-remoting-netty | 16.2% | 34.4%
dubbo-rpc-dubbo | 16.9% | 21.4%
dubbo-rpc-memcached | 17.0% | 84.2%
dubbo-remoting-mina | 17.7% | 48.1%
dubbo-remoting-grizzly | 19.4% | -
dubbo-rpc-thrift | 20.6% | 11.3%
dubbo-serialization-fastjson | 20.9% | -
dubbo-remoting-netty4 | 21.1% | 37.2%
dubbo-container-log4j | 21.3% | 61.3%
dubbo-config-api | 21.9% | 22.9%
dubbo-rpc-hessian | 21.9% | 20.0%
dubbo-registry-api | 22.2% | 20.8%
dubbo-registry-default | 23.4% | 17.0%
dubbo-serialization-protostuff | 24.1% | -
dubbo-serialization-fst | 24.6% | -
dubbo-common | 25.9% | 23.2%
dubbo-remoting-zookeeper | 26.0% | 22.9%
dubbo-rpc-rest | 28.4% | 33.8%
dubbo-rpc-rmi | 28.7% | 52.4%
dubbo-serialization-jdk | 28.8% | -
dubbo-filter-validation | 28.9% | 32.9%
dubbo-serialization-hessian2 | 30.3% | -
dubbo-config-spring | 30.7% | 26.7%
dubbo-serialization-kryo | 31.0% | -
dubbo-rpc-injvm | 31.7% | 39.2%
dubbo-remoting-api | 33.2% | 17.4%
dubbo-remoting-p2p | 33.4% | 23.6%
dubbo-container-logback | 33.7% | 48.7%
dubbo-qos | 34.3% | 32.6%
dubbo-container-spring | 34.5% | 57.6%
dubbo-cluster | 35.5% | 19.4%
dubbo-container-api | 35.8% | -
dubbo-rpc-api | 36.0% | 31.0%
dubbo-monitor-api | 37.0% | 15.4%
dubbo-filter-cache | 38.3% | 32.2%
dubbo-compatible | 40.3% | 23.8%
dubbo-remoting-http | 47.4% | 34.8%
dubbo-metrics-api | 50.8% | 19.9%
dubbo-test-spring3 | 51.5% | -
dubbo-demo-consumer | 52.5% | -
dubbo-demo-provider | 63.8% | -
dubbo-serialization-api | 79.1% | -
dubbo-demo-api | 80.0% | -
--------------
```bash
#!/bin/bash
# comment-coverage-report.sh
# generate comment coverage report, markdown table format
#
# NOTE:
# 1. run at project root dir
# 2. install ohcount: https://github.com/blackducksw/ohcount
# if you use mac install by brew: brew install ohcount
getCommentCoverage() {
local dir="$1"
local comment_coverage="$(ohcount "$dir" | awk '/^java /{print $5}')"
comment_coverage="${comment_coverage:--}"
echo "$comment_coverage"
}
getCommentCoveragePerModule() {
local pom
for pom in `find -name pom.xml`; do
local module_dir="$(dirname "$pom")"
local module_name="$(basename "$module_dir")"
local module_product_code_dir="$module_dir/src/main/java"
local module_test_code_dir="$module_dir/src/test/java"
[ ! -d "$module_product_code_dir" ] && continue
echo "$module_name | $(getCommentCoverage "$module_product_code_dir") | $(getCommentCoverage "$module_test_code_dir")"
done
}
genCommentCoverageReport() {
# output table header
echo "module | product code | test code"
echo "------ | ------------ | ---------"
# output table body
getCommentCoveragePerModule | sort '-t|' -n -k2
}
genCommentCoverageReport
```
[ Full content available at: https://github.com/apache/incubator-dubbo/issues/2884 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org
[GitHub] [incubator-dubbo] oldratlee commented on issue #2884: We
need more code comments
Posted by "oldratlee (GitHub)" <gi...@apache.org>.
comment coverage report generated by below scripts: ☺️
module | product code | test code
------ | ------------ | ---------
dubbo-registry-redis | 6.8% | 16.5%
dubbo-registry-multicast | 10.9% | 34.1%
dubbo-rpc-redis | 11.1% | 16.5%
dubbo-registry-zookeeper | 12.9% | 14.5%
dubbo-rpc-webservice | 13.4% | 41.5%
dubbo-monitor-default | 15.4% | 18.1%
dubbo-rpc-http | 15.8% | 22.0%
dubbo-remoting-netty | 16.2% | 34.4%
dubbo-rpc-dubbo | 16.9% | 21.4%
dubbo-rpc-memcached | 17.0% | 84.2%
dubbo-remoting-mina | 17.7% | 48.1%
dubbo-remoting-grizzly | 19.4% | -
dubbo-rpc-thrift | 20.6% | 11.3%
dubbo-serialization-fastjson | 20.9% | -
dubbo-remoting-netty4 | 21.1% | 37.2%
dubbo-container-log4j | 21.3% | 61.3%
dubbo-config-api | 21.9% | 22.9%
dubbo-rpc-hessian | 21.9% | 20.0%
dubbo-registry-api | 22.2% | 20.8%
dubbo-registry-default | 23.4% | 17.0%
dubbo-serialization-protostuff | 24.1% | -
dubbo-serialization-fst | 24.6% | -
dubbo-common | 25.9% | 23.2%
dubbo-remoting-zookeeper | 26.0% | 22.9%
dubbo-rpc-rest | 28.4% | 33.8%
dubbo-rpc-rmi | 28.7% | 52.4%
dubbo-serialization-jdk | 28.8% | -
dubbo-filter-validation | 28.9% | 32.9%
dubbo-serialization-hessian2 | 30.3% | -
dubbo-config-spring | 30.7% | 26.7%
dubbo-serialization-kryo | 31.0% | -
dubbo-rpc-injvm | 31.7% | 39.2%
dubbo-remoting-api | 33.2% | 17.4%
dubbo-remoting-p2p | 33.4% | 23.6%
dubbo-container-logback | 33.7% | 48.7%
dubbo-qos | 34.3% | 32.6%
dubbo-container-spring | 34.5% | 57.6%
dubbo-cluster | 35.5% | 19.4%
dubbo-container-api | 35.8% | -
dubbo-rpc-api | 36.0% | 31.0%
dubbo-monitor-api | 37.0% | 15.4%
dubbo-filter-cache | 38.3% | 32.2%
dubbo-compatible | 40.3% | 23.8%
dubbo-remoting-http | 47.4% | 34.8%
dubbo-metrics-api | 50.8% | 19.9%
dubbo-test-spring3 | 51.5% | -
dubbo-demo-consumer | 52.5% | -
dubbo-demo-provider | 63.8% | -
dubbo-serialization-api | 79.1% | -
dubbo-demo-api | 80.0% | -
--------------
```bash
#!/bin/bash
# comment-coverage-report.sh
# generate comment coverage report, markdown table format
#
# NOTE:
# 1. run at project root dir
# 2. install ohcount: https://github.com/blackducksw/ohcount
# if you use mac install by brew: brew install ohcount
getCommentCoverage() {
local dir="$1"
local comment_coverage="$(ohcount "$dir" | awk '/^java /{print $5}')"
comment_coverage="${comment_coverage:--}"
echo "$comment_coverage"
}
getCommentCoveragePerModule() {
local pom
for pom in `find -name pom.xml`; do
local module_dir="$(dirname "$pom")"
local module_name="$(basename "$module_dir")"
local module_product_code_dir="$module_dir/src/main/java"
local module_test_code_dir="$module_dir/src/test/java"
[ ! -d "$module_product_code_dir" ] && continue
echo "$(basename "$module_name") | $(getCommentCoverage "$module_product_code_dir") | $(getCommentCoverage "$module_test_code_dir")"
done
}
genCommentCoverageReport() {
# output table header
echo "module | product code | test code"
echo "------ | ------------ | ---------"
# output table body
getCommentCoveragePerModule | sort '-t|' -n -k2
}
genCommentCoverageReport
```
[ Full content available at: https://github.com/apache/incubator-dubbo/issues/2884 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org
[GitHub] [incubator-dubbo] oldratlee commented on issue #2884: We
need more code comments
Posted by "oldratlee (GitHub)" <gi...@apache.org>.
comment coverage report generated by below scripts: ☺️
module | product code | test code
------ | ------------ | ---------
dubbo-registry-redis | 6.8% | 16.5%
dubbo-registry-multicast | 10.9% | 34.1%
dubbo-rpc-redis | 11.1% | 16.5%
dubbo-registry-zookeeper | 12.9% | 14.5%
dubbo-rpc-webservice | 13.4% | 41.5%
dubbo-monitor-default | 15.4% | 18.1%
dubbo-rpc-http | 15.8% | 22.0%
dubbo-remoting-netty | 16.2% | 34.4%
dubbo-rpc-dubbo | 16.9% | 21.4%
dubbo-rpc-memcached | 17.0% | 84.2%
dubbo-remoting-mina | 17.7% | 48.1%
dubbo-remoting-grizzly | 19.4% | -
dubbo-rpc-thrift | 20.6% | 11.3%
dubbo-serialization-fastjson | 20.9% | -
dubbo-remoting-netty4 | 21.1% | 37.2%
dubbo-container-log4j | 21.3% | 61.3%
dubbo-config-api | 21.9% | 22.9%
dubbo-rpc-hessian | 21.9% | 20.0%
dubbo-registry-api | 22.2% | 20.8%
dubbo-registry-default | 23.4% | 17.0%
dubbo-serialization-protostuff | 24.1% | -
dubbo-serialization-fst | 24.6% | -
dubbo-common | 25.9% | 23.2%
dubbo-remoting-zookeeper | 26.0% | 22.9%
dubbo-rpc-rest | 28.4% | 33.8%
dubbo-rpc-rmi | 28.7% | 52.4%
dubbo-serialization-jdk | 28.8% | -
dubbo-filter-validation | 28.9% | 32.9%
dubbo-serialization-hessian2 | 30.3% | -
dubbo-config-spring | 30.7% | 26.7%
dubbo-serialization-kryo | 31.0% | -
dubbo-rpc-injvm | 31.7% | 39.2%
dubbo-remoting-api | 33.2% | 17.4%
dubbo-remoting-p2p | 33.4% | 23.6%
dubbo-container-logback | 33.7% | 48.7%
dubbo-qos | 34.3% | 32.6%
dubbo-container-spring | 34.5% | 57.6%
dubbo-cluster | 35.5% | 19.4%
dubbo-container-api | 35.8% | -
dubbo-rpc-api | 36.0% | 31.0%
dubbo-monitor-api | 37.0% | 15.4%
dubbo-filter-cache | 38.3% | 32.2%
dubbo-compatible | 40.3% | 23.8%
dubbo-remoting-http | 47.4% | 34.8%
dubbo-metrics-api | 50.8% | 19.9%
dubbo-test-spring3 | 51.5% | -
dubbo-demo-consumer | 52.5% | -
dubbo-demo-provider | 63.8% | -
dubbo-serialization-api | 79.1% | -
dubbo-demo-api | 80.0% | -
--------------
`comment-coverage-report.sh`:
```bash
#!/bin/bash
# comment-coverage-report.sh
# generate comment coverage report, markdown table format
#
# NOTE:
# 1. run at project root dir
# 2. install ohcount: https://github.com/blackducksw/ohcount
# if you use mac install by brew: brew install ohcount
getCommentCoverage() {
local dir="$1"
local comment_coverage="$(ohcount "$dir" | awk '/^java /{print $5}')"
comment_coverage="${comment_coverage:--}"
echo "$comment_coverage"
}
getCommentCoveragePerModule() {
local pom
for pom in `find -name pom.xml`; do
local module_dir="$(dirname "$pom")"
local module_name="$(basename "$module_dir")"
local module_product_code_dir="$module_dir/src/main/java"
local module_test_code_dir="$module_dir/src/test/java"
[ ! -d "$module_product_code_dir" ] && continue
echo "$module_name | $(getCommentCoverage "$module_product_code_dir") | $(getCommentCoverage "$module_test_code_dir")"
done
}
genCommentCoverageReport() {
# output table header
echo "module | product code | test code"
echo "------ | ------------ | ---------"
# output table body
getCommentCoveragePerModule | sort '-t|' -n -k2
}
genCommentCoverageReport
```
[ Full content available at: https://github.com/apache/incubator-dubbo/issues/2884 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org
[GitHub] [incubator-dubbo] ralf0131 commented on issue #2884: We need
more code comments
Posted by "ralf0131 (GitHub)" <gi...@apache.org>.
@khanimteyaz Maybe you don't have the permission. Please leave a comment about what you'd like to add, we can help you do that!
Please create an issue for your work, so that I can add your issue the to the project.
[ Full content available at: https://github.com/apache/incubator-dubbo/issues/2884 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org
[GitHub] [incubator-dubbo] oldratlee commented on issue #2884: We
need more code comments
Posted by "oldratlee (GitHub)" <gi...@apache.org>.
comment coverage report generated by below script: ☺️
module | product code | test code
------ | ------------ | ---------
dubbo-registry-redis | 6.8% | 16.5%
dubbo-registry-multicast | 10.9% | 34.1%
dubbo-rpc-redis | 11.1% | 16.5%
dubbo-registry-zookeeper | 12.9% | 14.5%
dubbo-rpc-webservice | 13.4% | 41.5%
dubbo-monitor-default | 15.4% | 18.1%
dubbo-rpc-http | 15.8% | 22.0%
dubbo-remoting-netty | 16.2% | 34.4%
dubbo-rpc-dubbo | 16.9% | 21.4%
dubbo-rpc-memcached | 17.0% | 84.2%
dubbo-remoting-mina | 17.7% | 48.1%
dubbo-remoting-grizzly | 19.4% | -
dubbo-rpc-thrift | 20.6% | 11.3%
dubbo-serialization-fastjson | 20.9% | -
dubbo-remoting-netty4 | 21.1% | 37.2%
dubbo-container-log4j | 21.3% | 61.3%
dubbo-config-api | 21.9% | 22.9%
dubbo-rpc-hessian | 21.9% | 20.0%
dubbo-registry-api | 22.2% | 20.8%
dubbo-registry-default | 23.4% | 17.0%
dubbo-serialization-protostuff | 24.1% | -
dubbo-serialization-fst | 24.6% | -
dubbo-common | 25.9% | 23.2%
dubbo-remoting-zookeeper | 26.0% | 22.9%
dubbo-rpc-rest | 28.4% | 33.8%
dubbo-rpc-rmi | 28.7% | 52.4%
dubbo-serialization-jdk | 28.8% | -
dubbo-filter-validation | 28.9% | 32.9%
dubbo-serialization-hessian2 | 30.3% | -
dubbo-config-spring | 30.7% | 26.7%
dubbo-serialization-kryo | 31.0% | -
dubbo-rpc-injvm | 31.7% | 39.2%
dubbo-remoting-api | 33.2% | 17.4%
dubbo-remoting-p2p | 33.4% | 23.6%
dubbo-container-logback | 33.7% | 48.7%
dubbo-qos | 34.3% | 32.6%
dubbo-container-spring | 34.5% | 57.6%
dubbo-cluster | 35.5% | 19.4%
dubbo-container-api | 35.8% | -
dubbo-rpc-api | 36.0% | 31.0%
dubbo-monitor-api | 37.0% | 15.4%
dubbo-filter-cache | 38.3% | 32.2%
dubbo-compatible | 40.3% | 23.8%
dubbo-remoting-http | 47.4% | 34.8%
dubbo-metrics-api | 50.8% | 19.9%
dubbo-test-spring3 | 51.5% | -
dubbo-demo-consumer | 52.5% | -
dubbo-demo-provider | 63.8% | -
dubbo-serialization-api | 79.1% | -
dubbo-demo-api | 80.0% | -
--------------
`comment-coverage-report.sh`:
```bash
#!/bin/bash
# comment-coverage-report.sh
# generate comment coverage report, markdown table format
#
# NOTE:
# 1. run at project root dir
# 2. install ohcount: https://github.com/blackducksw/ohcount
# if you use mac install by brew: brew install ohcount
set -euo pipefail
getCommentCoverage() {
local dir="$1"
local comment_coverage="$(ohcount "$dir" | awk '/^java /{print $5}')"
echo "${comment_coverage:--}"
}
listModulePoms() {
find . -name pom.xml
}
getCommentCoverageOfModule() {
local pom
while read pom ; do
local module_dir="$(dirname "$pom")"
local module_name="$(basename "$module_dir")"
local module_product_code_dir="$module_dir/src/main/java"
local module_test_code_dir="$module_dir/src/test/java"
# no product code dir, skip
[ ! -d "$module_product_code_dir" ] && continue
# output comment coverage table line of module
echo "$module_name | $(getCommentCoverage "$module_product_code_dir") | $(getCommentCoverage "$module_test_code_dir")"
done
}
genCommentCoverageReport() {
# output table header
echo "module | product code | test code"
echo "------ | ------------ | ---------"
# output table body
listModulePoms | getCommentCoverageOfModule | sort '-t|' -n -k2
}
genCommentCoverageReport
```
[ Full content available at: https://github.com/apache/incubator-dubbo/issues/2884 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org
[GitHub] [incubator-dubbo] oldratlee commented on issue #2884: We
need more code comments
Posted by "oldratlee (GitHub)" <gi...@apache.org>.
comment coverage report of https://github.com/apache/incubator-dubbo/commit/1f751a602654f52d1ea86488a66d56c2a8faced6 generated by below script:
NO. | module | product code | test code
--- | ------ | ------------ | ---------
1 | dubbo-demo-api | 0.0% (0/3) | -
2 | dubbo-serialization-fastjson | 0.0% (0/179) | -
3 | dubbo-serialization-fst | 0.0% (0/192) | -
4 | dubbo-serialization-protostuff | 1.0% (3/305) | -
5 | dubbo-rpc-http | 1.6% (3/184) | 4.3% (9/199)
6 | dubbo-registry-redis | 1.7% (10/572) | 0.0% (0/80)
7 | dubbo-rpc-redis | 1.9% (3/151) | 1.7% (3/175)
8 | dubbo-remoting-zookeeper | 2.4% (12/479) | 0.0% (0/264)
9 | dubbo-rpc-webservice | 2.4% (3/122) | 12.8% (16/109)
10 | dubbo-registry-zookeeper | 2.9% (8/268) | 3.3% (4/117)
11 | dubbo-serialization-jdk | 3.1% (12/376) | -
12 | dubbo-rpc-memcached | 3.2% (3/92) | 0.0% (0/2)
13 | dubbo-rpc-hessian | 3.4% (9/257) | 3.8% (9/225)
14 | dubbo-serialization-hessian2 | 3.7% (6/157) | -
15 | dubbo-registry-multicast | 3.8% (15/382) | 23.3% (44/145)
16 | dubbo-remoting-mina | 4.0% (23/549) | 20.2% (34/134)
17 | dubbo-container-log4j | 4.2% (3/69) | 21.4% (3/11)
18 | dubbo-monitor-default | 4.6% (17/354) | 1.9% (6/313)
19 | dubbo-remoting-netty | 4.9% (52/1007) | 11.1% (68/544)
20 | dubbo-remoting-grizzly | 5.1% (27/506) | -
21 | dubbo-rpc-dubbo | 6.0% (173/2716) | 5.3% (111/1969)
22 | dubbo-rpc-rest | 7.3% (58/738) | 3.6% (11/294)
23 | dubbo-rpc-thrift | 7.5% (93/1149) | 8.2% (677/7596)
24 | dubbo-serialization-kryo | 7.5% (34/422) | -
25 | dubbo-container-spring | 7.9% (3/35) | 18.8% (3/13)
26 | dubbo-filter-validation | 8.6% (33/349) | 0.0% (0/158)
27 | dubbo-rpc-injvm | 10.1% (15/133) | 6.1% (12/185)
28 | dubbo-compatible | 10.3% (245/2136) | 0.7% (11/1545)
29 | dubbo-rpc-rmi | 10.6% (13/110) | 34.2% (80/154)
30 | dubbo-registry-default | 11.4% (23/178) | 10.1% (172/1529)
31 | dubbo-remoting-p2p | 12.1% (117/852) | 0.0% (0/152)
32 | dubbo-remoting-netty4 | 12.2% (168/1213) | 7.6% (20/242)
33 | dubbo-container-api | 13.5% (12/77) | -
34 | dubbo-cluster | 14.1% (408/2482) | 7.6% (278/3387)
35 | dubbo-registry-api | 14.9% (350/1996) | 14.0% (129/791)
36 | dubbo-config-api | 16.1% (762/3962) | 4.9% (212/4103)
37 | dubbo-filter-cache | 16.8% (96/477) | 0.0% (0/196)
38 | dubbo-qos | 17.3% (289/1384) | 0.0% (0/706)
39 | dubbo-common | 18.6% (3414/14930) | 1.8% (159/8688)
40 | dubbo-monitor-api | 19.1% (52/220) | 2.8% (6/206)
41 | dubbo-container-logback | 19.4% (14/58) | 13.6% (3/19)
42 | dubbo-config-spring | 19.6% (683/2807) | 7.6% (238/2893)
43 | dubbo-remoting-api | 20.3% (1545/6054) | 6.0% (255/3979)
44 | dubbo-remoting-http | 20.5% (79/306) | 0.0% (0/58)
45 | dubbo-demo-provider | 20.8% (5/19) | -
46 | dubbo-test-spring3 | 21.1% (20/75) | -
47 | dubbo-rpc-api | 21.2% (1036/3851) | 4.7% (76/1551)
48 | dubbo-demo-consumer | 21.7% (5/18) | -
49 | dubbo-metrics-api | 40.5% (405/595) | 0.0% (0/127)
50 | dubbo-serialization-api | 71.6% (194/77) | -
--------------
`comment-coverage-report.sh`:
https://gist.github.com/oldratlee/6d02a849b8b84a9aba26be7ee65f5560
[ Full content available at: https://github.com/apache/incubator-dubbo/issues/2884 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org