如何指示函数相对于整个程序进行升级的时间

时间:2012-07-08 作者:amy

对于内联文档,有些php文档管理器在

有常见的@自@版本等。

我有很多功能,它们都是一个大软件包的一部分。但如果我想指出上次更新函数的时间,并显示mayor软件包的版本,该怎么办?

我应该只使用@version并为函数提供整个包的版本吗?

如果我造成混淆:

假设我的程序1.0中有一个带@自0.1的函数。然后,程序本身被开发到2.9版本,对于3.0版本,功能将发生变化。

所以实际上函数的版本现在应该是0.2,但我想在我的整个程序的哪个版本上显示它被更新了。那么,我应该在这个函数中跳转并说@Version3.0吗?

我刚用了一个@更新的,但那不存在,对吗?nothing like this documented here

有什么适合我的吗?

1 个回复
SO网友:fuxia

内联文档是跟踪更改的地方。有更好的工具:revision control. 使用Git、Mercurial或–如果你想保持老派;)-SVN。

每次更改某个内容时,都要做一个提交:一个简短的注释,解释上一个版本和新版本之间的差异(example).

通常,当你查看源代码时,你想知道它现在做了什么。以及原因。这些文档很重要。其他一切,包括@since, 不属于评论。

结束

相关推荐

Disable Comments Feed

我在一个私人网站上工作,那里需要隐藏评论。我知道如何从标题中删除注释提要,但是谁能给我一些关于如何完全禁用注释提要的说明呢。因为你所需要做的就是在单个帖子中添加/feed/然后你就可以看到评论feed了。我尝试创建feed-atom注释。php和feed-rss2-comments。php,但这仍然不起作用。