随笔分类 - 注释
摘要:json - 注释 我们要知道的是在json文件中用传统的注释格式(// /**/)进行注释,是不符合json规范的。 json里面有自己约定俗成的注释规范。 1、在json文件中,采用"//",其value就是添加的注释内容。 { "//": "设置起始刻度, 目的是为了是数据展示不从零起始显示,
阅读全文
摘要:注释标记 参考 vscode 插件推荐 todo-tree Xcode中使用TODO、FIXME、!!!、???、MARK 进行标记 注释标记 TODO: 标示处有功能代码待编写,使用方法:// TODO: FIXME:标示处代码需要修正,使用方法:// FIXME: !!!:标示处代码需要注意,使
阅读全文
摘要:好的注释可以提高代码的可读性和可维护性,从而提高代码质量。 注释的目的和原则 注释的目的: 提高代码的可读性,从而提高代码的可维护性 注释的原则: 如无必要,勿增注释 ( As short as possible ) 如有必要,尽量详尽 ( As long as necessary ) 我们写注释,
阅读全文