Как заставить Mercurial требовать, чтобы файлы имели документацию (Javadoc и т. Д.) Перед отправкой?

Question

Это возможно в настоящее время с помощью расширения или встроенной функциональности?

Спасибо,

Брэндон

Answer 1

Вы хотели бы получить хук перед фиксацией, который вызвал бы вашу программу проверки документов. Затем, основываясь на ответе на проверку документа, вы можете разрешить / запретить хук.

Answer 2

Хм, я забыл о хуках предварительной фиксации.

Если вы работаете в мире Java, вы можете использовать такие инструменты, как checkstyle , чтобы проверять Javadocs как часть вашегосборка для обеспечения соблюдения стандартов кодирования и таких, которые могут включать в себя наличие Javadocs для всего кода.

За документирование кода должна быть ответственность каждого разработчика, и они должны принять его близко к сердцу.Даже с такими инструментами, как checkstyle или с использованием ловушки перед фиксацией, вы можете только принудительно использовать некоторые Javadoc, присутствующие в коде, но не контролировать качество документации.

Если вы следуете передовым методам, таким как соблюдение стандартов кодирования и надежные обзоры одноранговых кодов, это избавит вас от необходимости требовать от Hg проверки Javadocs перед проверкой кода.

Только мой 2c,