使用 Homebrew 安装 standardese

项目链接

• 主页
• 仓库

命令和别名

• standardese

项目历史

The project describes itself as a library and command-line tool: the library parses C++ code with libclang, and the tool generates output such as Markdown and HTML. Its README emphasizes documentation in a style close to the C++ standard, including section commands such as effects, requires, returns, and throws.

采用历史

Official installation notes recommend a distribution package when available, with conda-forge packages for Windows, Linux, and macOS, Docker images, and source builds as alternatives. The GitHub release list records a 0.4.0 stabilization effort and later 0.5.x releases.

使用方式

The basic invocation is `standardese [options] inputs`, where inputs may be files or directories. The documentation notes that users should normally pass header files and may provide configuration options on the command line or in an INI-style config file.

为什么软件包爱好者会关心

Package maintainers care about standardese because C++ documentation generators often have heavy parser and compiler dependencies. Its packaging story is about making a libclang-based CLI reproducible across package managers, Docker, and source builds.

时间线

• 2020: Version 0.4.0 is described as the first stable release in a while after rewrites.
• 2020: Version 0.5.0 adds command-line and comment parsing options and requires a C++17 compiler.
• 2021: Version 0.5.2 is marked as the latest GitHub release on the official repository.

Related projects

• standardese is explicitly compared with Doxygen and depends on libclang for C++ parsing; its installation notes also mention conda-forge and Docker packaging.

来源

• https://github.com/standardese/standardese README: describes the project, libclang parsing, command-line usage, installation, and config format.
• https://github.com/standardese/standardese/releases: official release list and notes for 0.4.x and 0.5.x.
• https://standardese.github.io/: official documentation overview.