Java|嵌入式开发:记录嵌入式软件的10个技巧( 二 )



技巧 5 – 创建文档标准
就像编写代码一样 , 应该有一个与代码注释和文档开发相关的标准 , 由于文档标准中的项目几乎没有那么多 , 因此强烈建议将其汇总到编码标准中 , 这是为了确保团队中的每个人都以相同的方式评论和记录 , 以确保易于开发 , 开发人员应该专注于手头的问题 , 而不是试图浏览评论 。
技巧 6 – 使用文档模板
确保注释遵循标准的最简单方法是为标题、源和支持文档创建模板 。 创建新模块时 , 它是从模板创建的 , 然后添加相关信息 , 这将有助于确保文件信息块、代码段、函数和变量都以相同的格式注释 , 这种方法最好的部分是它还节省了大量时间 , 并且可以帮助减少将一个模块复制为另一个模块的假冒模板时的复制和粘贴错误 。
技巧 7 – 从图表中拉/推
在项目的软件实施阶段开始之前 , 应该有一个软件设计阶段 。 这个设计阶段无疑产生了许多漂亮的图表 , 例如在实际实现过程中使用的流程图和状态机 。 虽然这些文档充当了软件的路线图 , 但在开发和测试过程中总是存在偏差!不幸的是 , 这些变化很少会回到图表中 , 结果是设计文档和软件不匹配!在实施和测试阶段 , 嵌入式开发人员可以将这些图表放在手边 , 以便如果出现偏差 , 可以在现场更新图表 , 让它们稍后更新永远不是正确的答案 。 毕竟 , 我们总是有最好的打算回去更新或修复某些东西 , 但从来没有时间去做 。

技巧 8 – 一致地使用注释括号
听起来很奇怪 , 许多开发人员已经为何时、何地以及应该使用何种类型的注释括号而进行了战斗!这一切都归结为一致性 。 如果一个团队决定只使用 /* ... */ 样式的评论 , 那么就只使用那个样式 。 如果 // 样式已确定 , 则使用该样式 。 无论偏好如何 , 请确保每次都以相同的方式完成 , 这将有助于让生活更轻松一点 。
技巧 9 – 保持可读性(即格式良好)
保持代码结构化和易于阅读非常重要 , 以确保误解和错误不会进入代码 。 评论也不例外 。 零星结构的评论使眼睛很难捕捉到评论 , 更重要的是很难捕捉到不合适的东西 。 注释的格式应该是这样的 , 如果代码被打印出来 , 注释不会跨多个页面运行 。 如果你使用块指示符 , 则在文件头或函数注释等大块注释中 , 不要包含任何尾随字符 , 例如 # 或 * , 这只会使更新文档更加困难 。
技巧 10 – 嵌入图像和图表
通过使用自动化工具 , 嵌入式开发人员可以在构建的文档中包含编码标准、缩写、项目详细信息、要求和大量其他项目 , 甚至可以包括流程图等设计图!利用这种类型的功能 , 代码库不仅可以包含已执行的代码和逻辑 , 还可以在一个地方包含你可能想了解的有关项目的任何内容!