lampfire / ncpplib
一个用于创建C++应用程序占位文件的命令行工具(.cpp和.hpp)。
Requires
- php: >=5.4.0
This package is auto-updated.
Last update: 2022-09-02 18:14:53 UTC
README
ncpplib是一个为C++程序员设计的命令行工具,它可以从易于编写的JSON文件中创建C++类的占位文件(.cpp和.hpp)。它被编写为俄勒冈州立大学CS 162课程的个人工具。该应用程序的主要优点是在开发初期同步头文件和类文件。作者希望这个应用程序可以帮助新手,甚至可能是经验丰富的C++程序员节省数小时的调试时间,以便他们可以专注于实现应用程序逻辑。
安装
命令行程序是用PHP编写的。shebang路径通过/usr/bin/env调用PHP,以实现最大兼容性。如果您在配置异常的系统上运行此实用程序或想使用与在$PATH环境变量中定义的第一个不同的php二进制文件,您可能需要调整此设置。
环境变量
如果您在shell中设置环境变量FIRST_NAME和LAST_NAME为其逻辑值(例如,将它们放入本地等效的.bash_profile文件中),您的名字将出现在.cpp文件顶部的注释中,作为作者。例如。
export FIRST_NAME='Joe'
export LAST_NAME='Smith'
类配置文件
请查看此目录中的Example.json以获取一个有效示例。
截至版本0.2,ncpplib支持类配置文件。这些文件采用JSON格式,是可选的。当nccplib执行目录中的文件以CLASSNAME.json格式存在时,程序将尝试解析该文件。它将根据指定的属性生成类成员和访问器以及修改器函数。它还将包括指定的库和头文件。请参阅Example.json以获取有效示例。并非此文件中的所有功能都受支持。特别是,指定方法特性和生成占位符的功能尚未实现。
配置文件提示
ncpplib的关键设计考虑因素之一是尽可能减少输入,因为C++可能相当冗长。json文件中使用的名称反映了这一决策。最常见的键是单个字母,起初可能有些晦涩,但可以更快地构建配置文件。以下为这些单个字母名称的含义:
a : 访问级别 - 例如,public、private、protected
t : 类型 - 例如,int、float、string等。
n : 名称 - 方法的名称、属性或方法参数的名称。
v : 值 - 属性的值。
希望这种缩写可以迅速变得直观。
测试套件
截至版本0.2.2,ncpplib附带一个名为test.cpp的文件和一个makefile。makefile旨在为Example.json编译ncpplib的输出,编译它,链接它,并创建一个名为test的可执行文件。要运行测试套件,请转到以下
./ncpplib Example .
make
./test
如果这些命令没有错误运行,则程序按预期运行。您可以通过运行以下命令来整理安装目录
make clean
贡献
ncpplib是beta级别的开源软件。如果您修复了错误或扩展了其功能,请考虑提交pull request以帮助下一个使用此应用程序的用户。
(c)2015-2022 大卫·克劳特曼,麻省理工学院许可证