diff --git a/README.md b/README.md index e34bcd31b92..1357bb7be12 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ Contributions Mybatis-core is now being auto formatted. Given nature of some code logic with mybatis, it is more appropriate to force a formatting structure manually for snippets such as sql statements. To do so, add following blocks around code. - ```// @formatter:off``` to start the block of unformatted code - ```// @formatter:off``` to end the block of unformatted code +- ```// @formatter:off``` to start the block of unformatted code +- ```// @formatter:on``` to end the block of unformatted code If comment sections need same behaviour such as javadocs, note that the entire block must be around entire comment as direct usage does not properly indicate that formatter treats it all as one comment block regardless.