如何解决记录文件命名约定
我正在写一些关于配置文件文件命名的文档,我不知道这个问题是否属于这里,因为它与代码无关,但它在这里。
所以我想描述如何命名文件,我有一些类似的东西:
{client_name}-{product_name}-{season}-{id}.yaml
现在我的问题是因为client_name,product_name,season,and id 不一定是变量名,只是用来描述什么字符串去哪里,在多个单词描述中是否应该有下划线,或者我应该将它们用空格隔开,比如:
{客户名称}-{产品名称}-{季节}-{id}.yaml
我担心的是,由于下划线的存在,有人可能认为它们是变量,并在项目代码的某处而不是其他链接文档中查找它们。
解决方法
事实上,如果你的命名系统没有太大变化,它显然没有达到它的目的。
我几乎找不到这方面的标准,但一些广泛使用的是具有以下结构,或多或少修改
[Project Name]-[Department]-[Doc.Type]-[Number]-[Revision]
最后一种结构适用于确定的、不可改变的工作结构。以 CERN LHC Document Name Structure 为例。
另一方面,对于更动态但更扁平的环境,每天生成的文档,甚至是由相机或数据记录器等系统自动生成的,公开特定时间戳的内容更有用,日期格式为 {{1} } 或 YYYYMMDD
,甚至将时间戳扩展到小时、分钟或秒,以实现基于 ISO 日期的更多自动化流程YYYY-MM-DD
:
YYYYMMDDhhmmss
遗憾的是,没有任何标准命名约定,ISO-7001 或任何其他与命名系统相关的标准都没有,质量管理系统有很多工作来指定要使用的结构。
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。