开源 企业版 高校版 私有云 模力方舟 AI 队友
代码拉取完成,页面将自动刷新
加入 Gitee
与超过 1400万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
已有帐号? 立即登录
文件
main
分支 (1)
main
main
分支 (1)
main
克隆/下载
克隆/下载
提示
下载代码请复制以下命令到终端执行
为确保你提交的代码身份被 Gitee 正确识别,请执行以下命令完成配置
初次使用 SSH 协议进行代码克隆、推送等操作时,需按下述提示完成 SSH 配置
1 生成 RSA 密钥
2 获取 RSA 公钥内容,并配置到 SSH公钥
在 Gitee 上使用 SVN,请访问 使用指南
使用 HTTPS 协议时,命令行会出现如下账号密码验证步骤。基于安全考虑,Gitee 建议 配置并使用私人令牌 替代登录密码进行克隆、推送等操作
Username for 'https://gitee.com': userName
Password for 'https://userName@gitee.com': # 私人令牌
main
分支 (1)
main
comments
/
main.cpp
comments
/
main.cpp
main.cpp 9.91 KB
一键复制 编辑 原始数据 按行查看 历史
Ging 提交于 2024年12月05日 21:12 +08:00 . v0.1.0 初步完成函数注释功能
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341
#include <QCoreApplication>
#include <QCommandLineOption>
#include <QCommandLineParser>
#include <QDebug>
#include <QTimer>
#include <QFile>
#include <QDir>
#include <QTextCodec>
typedef struct{
quint32 row;
quint32 type;
QString templateFile;
}Command;
QString loadTemplate(QString path);
QString toUnicodeString(QByteArray &array);
QString toUnicodeString(QByteArray &array, QString &codec);
QByteArray encodeForName(QString code, QString unicodeStr);
/**
* 函数功能: initCLO
* 输入参数: -
* 返 回 值: QMap<选项, 值>
* 说 明: -
*/
QList<QCommandLineOption> initCLO()
{
QList<QCommandLineOption> oList;
// 添加命令选项
QCommandLineOption optType("t");
optType.setValueName("type");
optType.setDescription("注释类型,function or src or header");
oList.append( optType );
QCommandLineOption optRow("r");
optRow.setValueName("row");
optRow.setDescription("函数定义所在行(从0开始递增)");
oList.append( optRow );
QCommandLineOption optTemplate("p");
optTemplate.setValueName("template");
optTemplate.setDescription("注释模板文件");
oList.append( optTemplate );
return oList;
}
/**
* 函数功能: getOptionSet
* 输入参数: [parser] 命令选项解析器
* 返 回 值: Command
* 说 明: -
*/
Command getOptionSet( QCommandLineParser &parser )
{
// QStringList options = parser.optionNames();
// QMap<QString, QStringList> cmd; // QMap<name, values>
Command cmd;
if( parser.isSet("t") ){
QString type = parser.value("t");
cmd.type = 0;
if( type == "function" ){
cmd.type = 1;
}else if( type == "src" ){
cmd.type = 2;
}else if( type == "header" ){
cmd.type = 3;
}
}
if( parser.isSet("r") ){
cmd.row = parser.value("r").toInt();
}
if( parser.isSet("p") ){
cmd.templateFile = parser.value("p");
}
return cmd;
}
/**
* 函数功能: 插入函数注释
* 输入参数: [file] 源文件 [row] 光标所在行 [templateStr] 模板字符串(已正常转换成unicode编码)
* 返 回 值: -
* 说 明: -
*/
void insertFunctionComments( QFile *file, quint32 row, QString templateStr )
{
// row是在源编码格式下的行数,所以需要使用源编码格式处理
// 检测源文件编码格式
QByteArray rawData = file->readAll();
QString encode;
toUnicodeString( rawData, encode );
// 跳转到光标所在行
file->seek(0);
quint32 lineNum = 0;
while( lineNum++ < row ){
file->readLine();
}
qint32 fpos = 0;
do{
// 向下搜索非空行
if( file->atEnd() ){
break;
}
fpos = file->pos();
QByteArray data = file->readLine();
data = data.simplified();
if( data.isEmpty() ){
continue;
}
// 对非空白行应用正则表达式,提取函数名和参数(需要先转换成unicode编码格式)
QString str = toUnicodeString( data );
QRegExp regExp( "(.*)\\b([_a-zA-Z]\\w*\\b)\\s*\\((.*)\\)");
qint32 pos = regExp.indexIn(str);
if( pos >= 0 ){
QString name = regExp.cap(2);// 函数名
QString args = regExp.cap(3);
QString args_;
qDebug()<<regExp.capturedTexts();
file->seek(fpos);
// 提取参数,并且添加"[]"
if( args.simplified() == "void" ){
args = "-";
}else{
QString var;
args = args.simplified();
if( args.endsWith("...") ){
var="[...] ";
}
regExp.setPattern( "[_a-zA-Z]\\w*\\s+\\**([_a-zA-Z]\\w*)\\s*" );
pos = 0;
while( ( pos=regExp.indexIn(args,pos)) != -1 ){
pos +=regExp.matchedLength();
args_.append( QString("[%1] ").arg(regExp.cap(1)));
}
if( !var.isEmpty() ){
args_.append(var);
}
}
// 替换模板 // @todo:替换data,time,author等变量
if(templateStr.isEmpty()){
templateStr = "/**\r\n"
" * 函数功能: ${function}\r\n"
" * 输入参数: ${args}\r\n"
" * 返 回 值: -\r\n"
" * 说 明: -\r\n"
" */\r\n";
}
templateStr.replace("${function}", name);
templateStr.replace("${args}", args_);
// 将模板转换成源数据的编码格式,并插入到源数据中
QByteArray insert = encodeForName(encode, templateStr);
qDebug().noquote()<<"add comments\r\n"<<insert;
if( !insert.isEmpty() ){
rawData.insert( fpos, insert );
}
// 覆盖源文件
file->seek(0);
file->write( rawData );
}
break;
}while(1);
qDebug()<<"finish";
}
int main(int argc, char *argv[])
{
QCoreApplication a(argc, argv);
a.setApplicationVersion("v0.1");
a.setApplicationName("comments");
QCommandLineParser cmdParser;
cmdParser.setApplicationDescription("Add comments for function/file");
cmdParser.addHelpOption();
cmdParser.addVersionOption();
cmdParser.addPositionalArgument("file", "the file to open");
QList<QCommandLineOption> optionList = initCLO();
cmdParser.addOptions(optionList);
// 解析应用进程的参数
if( argc == 1 ) {
cmdParser.showVersion();
cmdParser.showHelp();
return 0;
}else{
cmdParser.process( a );
Command cmd = getOptionSet(cmdParser);
if( cmdParser.positionalArguments().isEmpty() ){
cmdParser.showHelp();
return 0;
}
QString file = cmdParser.positionalArguments().at(0);
QFile txtFile(file);
if( txtFile.open(QIODevice::ReadWrite) ){
// 加载模板
QString temp = loadTemplate(cmd.templateFile);
// 插入注释
switch(cmd.type){
case 1:
insertFunctionComments( &txtFile, cmd.row , temp );
break;
case 2:
break;
case 3:
break;
default:
cmdParser.showHelp();
return 0;
break;
}
txtFile.close();
}
}
a.exit(0);
return 0;
}
/**
* 函数功能: 将unicode字符串按名字编码
* 输入参数: [code] 编码格式的名字 [unicodeStr] unicode字符串
* 返 回 值: -
* 说 明: 将unicodeStr 按照code编码格式转化编码
*/
QByteArray encodeForName(QString code, QString unicodeStr)
{
QTextCodec *codec = QTextCodec::codecForName(code.toLatin1());
QTextEncoder *encoder = new QTextEncoder( codec );
QByteArray array = encoder->fromUnicode( unicodeStr );
if( encoder->hasFailure() ){
return QByteArray();
}else{
if( code == "UTF-8" ){
return array.mid(3); // 使用fromUnicode 转换UTF-8是带有BOM的数据
}else{
return array;
}
}
}
/**
* 函数功能: 转换成unicode格式的QString字符串
* 输入参数: [array] 未知编码的源数据
* 返 回 值: [encode] 源数据的编码格式 [QString]转换之后的字符串
* 说 明: -
*/
QString toUnicodeString(QByteArray &array, QString &encode)
{
// ConverterState.invalidChars 实测invalidChars为非unicode的字符数,不能用于判断编码类型
QString str;
QString tmp;
QTextCodec *codec = QTextCodec::codecForName("UTF-8");
QTextDecoder *decoder = new QTextDecoder(codec );
tmp = decoder->toUnicode( array );
if( !decoder->hasFailure()){
str = tmp;
encode.clear();
encode.append("UTF-8");
// qDebug()<<"UTF-8";
}
delete decoder;
decoder = NULL;
codec = QTextCodec::codecForName("GB18030");
decoder = new QTextDecoder(codec );
tmp = decoder->toUnicode( array );
if( !decoder->hasFailure()){
// qDebug()<<"GB18030";
str = tmp;
encode.clear();
encode.append("GB18030");
}
delete decoder;
return str;
}
/**
* 函数功能: 转换成unicode格式的QString字符串
* 输入参数: [array] 未知编码的源数据
* 返 回 值: [QString]转换之后的字符串
* 说 明: -
*/
QString toUnicodeString(QByteArray &array)
{
// ConverterState.invalidChars 实测invalidChars为非unicode的字符数,不能用于判断编码类型
QString str;
QString tmp;
QTextCodec *codec = QTextCodec::codecForName("UTF-8");
QTextDecoder *decoder = new QTextDecoder(codec );
tmp = decoder->toUnicode( array );
if( !decoder->hasFailure()){
str = tmp;
// qDebug()<<"UTF-8";
}
delete decoder;
decoder = NULL;
codec = QTextCodec::codecForName("GB18030");
decoder = new QTextDecoder(codec );
tmp = decoder->toUnicode( array );
if( !decoder->hasFailure()){
// qDebug()<<"GB18030";
str = tmp;
}
delete decoder;
return str;
}
/**
* 函数功能: 加载注释模板数据
* 输入参数: [path] 带后缀的模板文件的路劲
* 返 回 值: -
* 说 明: -
*/
QString loadTemplate(QString path)
{
QFile file(path);
if(file.open( QIODevice::ReadOnly )){
QByteArray array = file.readAll();
file.close();
return toUnicodeString( array );
}
else{
return QString();
}
}
Loading...
举报
举报成功
我们将于2个工作日内通过站内信反馈结果给你!
请认真填写举报原因,尽可能描述详细。
请选择举报类型
取消
发送
误判申诉

此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。

如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。

取消
提交

简介

在函数前面添加注释
暂无标签
Apache-2.0
使用 Apache-2.0 开源许可协议
取消

发行版

暂无发行版

贡献者

全部

语言

近期动态

不能加载更多了
编辑仓库简介
简介内容
主页
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/Ging_H/comments.git
git@gitee.com:Ging_H/comments.git
Ging_H
comments
comments
main
点此查找更多帮助

搜索帮助

评论
仓库举报
回到顶部
登录提示
该操作需登录 Gitee 帐号,请先登录后再操作。
立即登录
没有帐号,去注册

AltStyle によって変換されたページ (->オリジナル) /