思想:分析文档使用YAML格式如何(9)

原创
2012/01/11 15:06
阅读数 417
思想:分析文档使用YAML格式如何(9)

分析文档怎么写用什么格式?这对于开发人员来说很迷茫,总希望能给自己一个框框。但实际上真的给了框框又会觉得麻烦,比如分析文档使用纯文本但要符合YAML格式,这样很多程序员就会觉得很麻烦,因为给自己的限制太多了。但另外一方面符合YAML格式的容易被程序解析,这样将来做成一个分析文档的管理工具的时候就很简单了。

但是从思想角度考虑这个问题,就会发现符合某种格式的分析文档并不是一个很好的想法,因为并不是所有的人都会熟悉YAML格式,就算熟悉也不能保证完全符合格式,并且也没有必要用工具去验证是否符合格式,因为这个毕竟只是一个文档罢了。当然如果非得要给自己一些框框的话,YAML格式是一个不错的选择。

PHP框架CoreMVC的模块文件里的需求分析文档文件名是这么定义的,比如user模块的程序包就是user.zip,里面除了user.php和user目录外,还有user.txt及user.sql,user.txt就是需求分析文档,user.sql就是数据库表结构。用模块名而不是用统一的readme.txt的好处是下载了多个模块的话不会被覆盖掉。

2012.1.11
展开阅读全文
打赏
0
0 收藏
分享
加载中
更多评论
打赏
0 评论
0 收藏
0
分享
返回顶部
顶部