BOM导致的Build failed in Jenkins with error MSB4025

昨天有个release持续build fail，报错为

error MSB4025: The project file could not be loaded. Data at the root level is invalid. Line 1, position 1.

用Notepad++临时打开查看，没有发现任何异常

在Stash上能发现文件开始处多了一些小红点

这个 "\ufeff" 就是BOM （byte order marks） [wiki]

既然代码里有这个，删除即可，jenkins build success

查看了Master上的代码，没有这个问题，所以平时也不会有问题。

在这个Release Branch上查看History， 发现红点出自去年的某次提交，然后在这个branch中便一直保留下来了。

正好昨天merge一些code ，所以带出来这个问题。

因为BOM是Windows的默认模式，所以在跨平台工作的时候，很容易出现这个问题，肉眼很难分辨出来。

在Unix下用VI做个实验：

With BOM

Without BOM

结果立现！

结论 ： Windows下默认编辑器的UTF-8是with BOM的，而UTF-16因为涉及到Big-Endian/Little-Endian，也会添加BOM的标识在字节流的开头。所以建议所有源文件使用UTF-8 without BOM的 格式存储。