F Prime 命名规范NomenclatureF´、F Prime 与 fprime 的官方书写与使用指南【免费下载链接】fprimeF´ - A flight software and embedded systems framework项目地址: https://gitcode.com/GitHub_Trending/fpr/fprime本篇技术指南基于 F Prime 官方文档 nomenclature.md 编写系统梳理 F PrimeF´框架及其建模语言 FPPF Prime Prime在正式与非正式场景下的标准书写形式、使用规则与常见误区。读完本文你将能够在论文、演示文稿、邮件、代码仓库与软件标识符中准确使用 F Prime 生态的标准名称避免因大小写、符号或空格使用不当造成的歧义。为什么需要一套命名规范F Prime 生态的名称在印刷与软件环境中存在多种表达方式既可以是“F Prime”这样的自然语言词组也可以是带 prime 符号的“F′”还可以是软件仓库与标识符中必须使用的纯小写“fprime”。如果这些形式混用会给正式文档、搜索引擎检索以及自动化工具带来不必要的歧义。该文档作为 F Prime 官方文档站 Reference 章节 的组成部分为所有文档作者、开发者与社区贡献者提供了统一的“官方表示法”确保同一名称在不同媒介下保持一致、可识别、无歧义。同时文档站全局配置见 docs/mkdocs.yml中的site_name: F Prime也直接采用了这一命名规范。F Prime 名称的四种官方表示形式根据 nomenclature.mdF Prime 的名称有长形式与短形式之分短形式又区分为正式与非正式两种另外还有一种仅用于软件环境的 slug 表示法。整理如下表示法书写形式适用场景要点长形式Long formF Prime所有交流场景大写 F、大写 P中间有空格不使用连字符、下划线、小写字母或缺失空格正式短形式Short form – formalF′所有正式交流尤其适合演示文稿、论文、海报、用户指南、提案等大写 F 后跟 prime 符号U2032非正式短形式Short form – informalF’非正式交流如电子邮件大写 F 后跟撇号apostrophe软件 slugSoftware slugfprime软件标识符、仓库名等全部小写无空格与特殊符号长形式F Prime写法大写字母 F、空格、大写字母 P即F Prime。禁用写法F-Prime连字符、F_Prime下划线、f prime小写 f、fprime连写以及缺失空格等任何变体均不被接受。长形式是名称的“完整形态”用于所有交流场合尤其当读者可能第一次见到该名称时。正式短形式F′写法大写 F 后紧跟 prime 符号prime symbol即 U2032而非撇号或引号。适用场景所有正式交流特别是演示文稿presentations、论文papers、海报posters、用户指南user guides、提案proposals等印刷或展示场合。如何在 Office 软件中输入 prime 符号在 PowerPoint、Word 或 Outlook 中打开 Insert插入菜单选择 Symbols符号在弹出的符号列表中选取 prime 符号即可。非正式短形式F’写法大写 F 后跟撇号apostrophe。适用场景电子邮件等非正式交流。说明非正式场景中经常出现的F’撇号与正式场景的F′prime 符号是两个不同的字符其用途也刻意做了区分。软件 slugfprime写法全部小写的fprime无空格、无符号。适用场景软件标识符software identifiers、仓库名repository names等禁止空格与特殊字符的环境。这一点在当前仓库中有大量直接体现仓库根目录名即为fprime见 README.md 与 CMakeLists.txt而整个仓库中.fpp建模文件、Fw/、Svc/等源码目录内的标识符均采用小写fprime风格例如 Fpp/ToCpp.fpp 中定义的module Fpp { module ToCpp { ... } }结构。也就是说在代码、构建脚本、包名与仓库地址中应始终使用 slug 形式而不是带空格或 prime 符号的自然语言形式。使用规则何时用长形式何时用短形式按照官方文档长形式与短形式在大多数情况下可以互换使用但存在几个明确例外正式叙述性文档如论文或演示文稿名称的首次出现应使用长形式F Prime后续出现再切换为短形式如F′类似于首次给出全称、随后使用缩写的惯例也可以在整个文档中始终使用长形式。主标题或横幅major headers or banners在这些很可能被广泛读者首次看到名称的位置应只使用完整的长形式F Prime。软件 token 场景slug 形式fprime仅作为软件开发令牌使用例如标识符、仓库名的一部分或任何禁止空格和特殊字符的位置它不应出现在自然语言叙述中。F Prime PrimeFPP命名参考F Prime 生态中还有一个重要的名称FPP——软件建模前端领域特定语言domain specific language的名称。它同样拥有长形式与短形式长形式F Prime Prime适用于所有交流场景。口语中的“F double-prime”在非正式口头交流中可以接受但在印刷品中不能这样写。短形式FPP写法三个大写字母FPP适用于所有交流场景。官方文档给出了一个略带幽默的说明为什么框架叫F′一个 prime而 DSL 不叫F′′两个 prime答案是——没有特别的技术理由仅仅是因为FPP相比F′′更容易与F′区分。这一点也从侧面说明命名规范的首要目标是可区分性与无歧义性。FPP 在仓库中的实际地位FPP 是 F Prime 生态中真正驱动工程实践的建模语言。在当前仓库中顶层 Fpp/ToCpp.fpp 定义了Fpp.ToCpp模块其中用枚举描述了 FPP 模型向 C 代码生成转换的各个阶段configConstants、instances、initComponents、startTasks、tearDownComponents等可见 FPP 不仅是名字更贯穿于代码生成流水线。FppTestProject/FppTest 是围绕 FPP 语言特性搭建的完整测试工程覆盖 array、component、enum、struct、state_machine、topology 等语言构件其中 FppTestProject/FppTest/topology/main/topology.fpp 以deployment topology FppTest { ... }的语法展示了 FPP 描述部署拓扑的方式。官方文档还包含一份完整的 FPP JSON Dictionary Specification用于描述 FPP 编译器输出的 JSON 字典格式涵盖类型描述符、常量、类型定义与取值等章节。文档站 docs/index.md 的 Tutorials、How-To 与 Reference 部分均以 “FPP language specification” 为技术参考条目例如 docs/how-to/develop/python-development.md 等文档中大量出现 FPP 相关说明。由此可以推断FPP这一短名称在 F Prime 生态中既是官方的规范名称也是代码、工具链与文档中普遍使用的稳定 token。常见错误速查表场景正确错误论文/文档首次提及F PrimeF’撇号、fprime演示文稿/海报F′prime 符号F’撇号、F-Prime邮件等非正式交流F’撇号F′prime 符号可接受但不推荐仓库名/标识符fprimeF Prime、F′、F-Prime建模语言名称FPPF′′、F double-prime印刷品中禁用小结F Prime 命名规范的核心思想可以概括为三句话自然语言中首次出现用长形式F Prime之后可用正式短形式F′或非正式短形式F’面向广泛读者的标题与横幅中只用长形式F Prime软件环境中一律使用 slug 形式fprime其建模语言统一写作FPP长形式F Prime Prime。这套规范不仅是“排版洁癖”更是保证一个多组件、多语言、跨文档的大型开源生态在论文、提案、代码与检索中保持名称一致性的基础设施。作者与贡献者在撰写或提交内容时可随时参考 docs/reference/nomenclature.md 作为最终依据。【免费下载链接】fprimeF´ - A flight software and embedded systems framework项目地址: https://gitcode.com/GitHub_Trending/fpr/fprime创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考