我正在用院子来生成我项目的文件.即使认为文档可以生成,因此不需要进行版本化,我们决定这样做,因为它可以更容易地看到代码(注释)在实际文档中的变化的影响.
问题是每个时间段生成文档,它会更改每个文件开头的日期,导致所有文件被视为已更改.
有没有办法告诉git忽略那些行来检测文件是否已经改变,或者是一种方法来配置码不重新生成文件,如果它们是相同的?
谢谢
我知道我可以做一个脚本或其他什么,如果只有日期改变了,它会清理文件.所以我的问题是有一种Git方法可以做.我应该阅读有关diff驱动程序的内容,还是应该使用干净的脚本.
如果我要走向清理路径,那么使用git hook或将其集成到doc生成中会更好.
最终,我对跟踪由于生成的doc中的特定提交而导致的更改的任何其他方式感兴趣.
我还没有真正解释我的问题是什么(以及为什么我要尝试编写不需要的东西)所以我们去了.
有时,代码中的一点修改搞砸了文档,因此我将能够看到提交对文档的影响.
示例:我使用modeline for vim(文件第一行的注释告诉vim不同的信息)
知道我有一个包含模块文档的文件
#vi: my vim setting
# Documentation of module A
module A
.... some code
end
Run Code Online (Sandbox Code Playgroud)
在其他地方我使用这个模块
#vi : my vim setting
( 2 blank lines)
module A
.... some different code
end
Run Code Online (Sandbox Code Playgroud)
那时,一切都很好,A的文档就是Documentation of module A
.但是如果某个人(像我一样)删除了最后一个文件中的空白行并且只留下一行(是的,我在模式行和代码之间放了2个空行),那么院子认为模式行是模块A的文档vi : my vim setting
.
问题是,除了查看每一页之外,没有办法检测到文档被搞砸了.使用git,我可以快速查看并检查更改的内容,甚至可以找到什么时候(这很重要,因为那时我可以弄清楚它为什么会发生变化).
文件中根本没有日期就足够了吗?
特定于院子的解决方案(但不是特定于 git 的),如果您实际上不使用这些日期 - 让院子首先不生成它们:
创建一个空文件customtemplates/default/layout/html/footer.erb
,然后将其包含在您的模板中:
使用命令行
yardoc --template-path ./customtemplates
Run Code Online (Sandbox Code Playgroud)使用 Rakefile
YARD::Rake::YardocTask.new do |yardoc|
yardoc.options = ["--template-path", "./customtemplates"]
end
Run Code Online (Sandbox Code Playgroud)(或者,如果您仍然想向 Yard 确认,可以将以下内容放入文件中customtemplates/default/layout/html/footer.erb
)
<div id="footer">
Generated by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>.
</div>
Run Code Online (Sandbox Code Playgroud)
或者您可以放入自己的页脚,其中包含您的公司徽标或其他信息。
归档时间: |
|
查看次数: |
1113 次 |
最近记录: |