自动从源代码管理中删除注释或将代码注释保存在单独的物理文件中

时间:2011-11-27 23:16:25

标签: visual-studio git svn xml-comments code-comments

是否可以在提交源代码管理之前自动删除Visual Studio文件中的代码注释,或者是否可以在文件中虚拟地添加注释但是将它们实际存储在单独的文件中?

最终目标不是在源代码管理中拥有评论,而是能够在本地拥有评论。

2 个答案:

答案 0 :(得分:4)

这是错误的。

您应删除的内容是注释掉的代码。让版本控制系统完成它的工作。评论说明代码中的内容以及为什么应该保留。

如果在源代码管理中删除它们,您希望如何保留它们?下次检查代码时,注释不会出现。

答案 1 :(得分:1)

对于开发,最好在代码中保留注释。不要删除它们。您不能在本地发表评论并提交未评论的文件,因为在签出您的存储库时,它根本就没有评论。

通过评论,其他开发人员能够更快地找出正在发生的事情并且更加精确。他们可以找到错误并改进您的代码。所以,评论很酷。我的意思是,好评。我知道代码必须单独说话,但评论也很重要。

如果您打算节省存储空间,请不要在开发过程中这样做。您可以做的是在任何评论中部署您的代码,并且如果可能的话,进行压缩。

我们正在使用编程语言agnosic,但我很确定每种语言都有某种方法可以删除注释并对其进行优化以进行部署。