#文档 #自动化 #cli #rust

app docstring-rs

📒 为新文件或现有文件生成或更新文档字符串

2 个不稳定版本

0.3.0 2023 年 10 月 4 日
0.2.0 2023 年 10 月 1 日

#2650 in 命令行工具

自定义许可证

44KB
866 行(不包括注释)



Crates.io (latest) License: MIT codecov CI Tests

🔎 概述

自动生成新文件或更新现有代码库,基于许可证信息生成头部文档字符串。

📦 安装

cargo install docstring-rs

🚀 使用方法

Usage: docstring-rs.exe [OPTIONS] --directory <DIRECTORY>

Options:
  -d, --directory <DIRECTORY>  Name of the directory in which to create new file or update existing files,
                               if it does not already exist, creates the directory
  -f, --file <FILE_NAME>       Name of a new file to create with docstring as header. Prepends to top of
                               file if the target file already exists [default: *.*]
  -l, --license <LICENSE>      Relative path to the LICENSE file to use as header docstring. If not specified,
                               expects a LICENSE file to exist in the current working directory [default: LICENSE]
  -u, --update                 Specify whether or not to try and update all available docstrings in a directory
                               recursively, requires <DIRECTORY> to have been set
  -h, --help                   Print help
  -V, --version                Print version

📋 许可证

所有代码均受通用 MIT 许可证约束,请参阅 LICENSE 了解具体信息。

依赖项

~5.5–7.5MB
~128K SLoC