备案 cloc 统计代码行数,区分代码行、注释行和空行

一、简介

  • cloc 是一个开源命令行工具,可以统计代码行数,区分代码行、注释行和空行。
  • 安装

    $ npm install -g cloc
    
  • 使用: 在项目根目录运行以下命令:

    $ cloc .
    
    • 输出结果会显示各个文件的代码行数。

二、Flutter 项目示例

  • 以一个 Flutter 项目为例,步骤:

    1. 在项目根目录运行:

      $ cloc lib/
      

      假设结果如下:

      -------------------------------------------------------------------------------
      Language                     files          blank        comment           code
      -------------------------------------------------------------------------------
      Dart                            25           1500            500           8000
      -------------------------------------------------------------------------------
      
    2. 结果说明:

      • blank:空行数(1500)
      • comment:注释行数(500)
      • code:有效代码行数(8000)
    3. 直接填入表格中的“源程序量”为:

      8,000

三、常见问题

  1. 注释和空行需要包含吗?

    • 一般包括注释和空行,除非明确要求只统计有效代码行。
  2. 生成代码是否计入?

    • 自动生成的代码(如 .g.dart 文件)通常不计入,但实际可以根据需要调整。
  3. 代码量的参考范围

    • 对于一般应用软件,代码量通常在 1,000 至 50,000 行 之间。

如果不确定源程序量的精确值,可以保守估计,例如:

  • 小型项目:1,000 ~ 5,000 行。
  • 中型项目:5,000 ~ 20,000 行。
  • 大型项目:20,000 行以上。