我想确保在有人将某些内容提交到 SVN 存储库之前,对 Java 类进行了注释。所以我想实现以下工作流程:
- 用户更改类中的某些内容
- 用户想要提交课程
- 在执行对存储库的提交之前,SVN 或其他东西会检查类之前和
public
方法之前是否有注释(对于 Java AutoDoc)。 - 如果有评论 => 提交,否则返回错误信息
我怎么能意识到这一点?我发现了很多关于预提交钩子的信息。但一切都是为了检查是否设置了提交消息/评论。
如果有人可以为这个问题提供解决方案,那将是非常好的和有帮助的。
我想确保在有人将某些内容提交到 SVN 存储库之前,对 Java 类进行了注释。所以我想实现以下工作流程:
public
方法之前是否有注释(对于 Java AutoDoc)。我怎么能意识到这一点?我发现了很多关于预提交钩子的信息。但一切都是为了检查是否设置了提交消息/评论。
如果有人可以为这个问题提供解决方案,那将是非常好的和有帮助的。
是的,你可以做到,使用CheckStyle。
首先,下载 CheckStyle jar,并将其安装在某个地方。然后,为 CheckStyle 创建一个新的xml 配置文件,以检查您的公共方法/类是否有一些 JavaDoc(例如,您可以将其称为 javadoc_check.xml):
<?xml version="1.0"?>
<!DOCTYPE module PUBLIC
"-//Puppy Crawl//DTD Check Configuration 1.3//EN"
"http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
<module name="Checker">
<module name="TreeWalker">
<module name="JavadocMethod">
<property name="scope" value="public"/>
</module>
<module name="JavadocType">
<property name="scope" value="public"/>
</module>
</module>
</module>
完成后,您可以创建 pre_commit 钩子,如下所示:
#!/bin/bash
REPOS="$1"
TXN="$2"
CHECKSTYLEJAR=/path/to/checkstyle-5.7/checkstyle-5.7-all.jar
CHECKSTYLECONFIG=/path/to/javadoc_check.xml
SVNLOOK=/usr/bin/svnlook
JAVA=/usr/bin/java
EXITSTATUS=0
ERRORMARKER=__ERROR_MARKER__
# Create temporary dir
TMPDIR=$(mktemp -d)
# Iterate on the files commited
while read changeline;
do
# Get the filename
file=${changeline:4}
# Check if it's an Updated or Added java file
if [[ $file == *.java && ($changeline == U* || $changeline == A*) ]] ; then
# Get the file content in a temporary file
$SVNLOOK cat -t "$TXN" "$REPOS" "$file" > $TMPDIR/${file##*/}
echo -e "\n=> Checking $file"
# Check the file with checkstyle
( $JAVA -jar $CHECKSTYLEJAR -c $CHECKSTYLECONFIG $TMPDIR/${file##*/} 2>&1 || echo "$ERRORMARKER" 1>&2 ) | sed -e "s{$TMPDIR/{{"
# Delete the temporary file
rm $TMPDIR/${file##*/}
fi
done < <($SVNLOOK changed -t "$TXN" "$REPOS") 3>&2 2>&1 1>&3 | grep "$ERRORMARKER" && EXITSTATUS=1 # Check for errors
# Delete temporary dir
rmdir $TMPDIR
exit $EXITSTATUS
不要忘记更改 CheckStyle jar 和 CheckStyle 配置的路径。
下次您尝试在公共方法/类上提交没有 JavaDoc 注释的 java 文件时,提交将被取消,并且您将收到一条错误消息:
$ svn commit
Sending test.java
Transmitting file data .svn: E165001: Commit failed (details follow):
svn: E165001: Commit blocked by pre-commit hook (exit code 1) with output:
=> Checking test.java
Starting audit...
test.java:9:1: Missing a Javadoc comment.
Audit done.
svn: E165001: Your commit message was left in a temporary file:
svn: E165001: '/path/to/project/svn-commit.1.tmp'
$
如果你提交了多个文件,所有的文件都会被检查,只有当所有修改/添加的java文件都有JavaDoc注释时才会授权提交。