代码注释的格式

写软件代码期间：

各种语言都有自己的常见的写注释的约定俗成的方式：

有了大家一起都常用的，都遵守的格式，作用是：

就可以通过第三方的工具，去将代码中的注释提取出来，形成代码的文档

即：从代码中生成文档

比如：

• Java
  • javadoc
• Python
  • doc string
• Xcode
  • 和普通的C/C++类似的函数注释
• R
  • 从：
  • childes-db: API
  • 知道有：
    • r-lib/pkgdown: Generate static html documentation for an R package
    • Make Static HTML Documentation for a Package • pkgdown

举例

Xcode

有对应的插件，帮你自动生成格式：

给Xcode添加支持给iOS代码写注释和文档

GitHub - onevcat/VVDocumenter-Xcode: Xcode plug-in which helps you write documentation comment easier, for both Objective-C and Swift.