简单实现注释转换(/* */)→(//)

本文档介绍如何在C语言中实现将/* */注释转换为//注释。通过分析文件内容,处理不同状态,利用枚举类型表示状态转换,并提供相关代码示例。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

这只是简单实现,将一个正确代码中的注释进行转换,如果代码里面有错误的话,可能会出现问题,比如出现了 /* 但是不出现 */ 如果这时候文件结束了,这样注释转换就会出错,所以转换前,应先保证注释的正确性。(以下情况均是在注释正确的情况下进行)
话不多说,进入正题。
先分析一波:

我们读取一个.c文件时,第一个可能读取到的字符可能有 / 、正常代码、和EOF(文件为空,直接为文件尾)

  • 当读到正常代码时,直接将正常代码写入到新的文档中即可。
  • 当读到EOF时,代表文件读完,返回即可。
  • 当读到/时,分为两种情况:

    • / 的下一位为/ 这时,就是//注释,它不需要转换,直接写入文档即可。
    • /的下一位为* 这时,就是/*注释,它需要转换。
      而上面这两种情况对于读取到的字符的处理方式又不同,所以到时候需要再写两个函数来处理它们。

首先,我们将这几种情况用枚举类型罗列出来:

    typedef enum State
{
    NUL_State,           //无状态,即正常代码状态
    C_State,               //C注释状态,即 /*  */ 注释状态
    CPP_State,         //C++注释状态,即 // 注释状态
    END_State            //结束状态,即读取到文件结尾
}State;

我们可以将它们几种状态的转换关系再画出来:
这里写图片描述
黑色的字体为状态之间转换的条件。

接下来,我们用代码来实现:
采用多文件编译的方式:

CommentConvert.h
#ifndef __CommentConvert_H__
#define __CommentConvert_H__

#include<stdio.h>
#include<stdlib.h>

typedef enum State
{
    NUL_State,
    C_State,
    CPP_State,
    END_State
}State;

void CommentConvert(FILE *PRead, FILE *PWrite);         //注释转换

void DO_NUL_State(FILE *PRead, FILE *PWrite, State *PState);    //无状态执行操作

void DO_C_State(FILE *PRead, FILE *PWrite, State *PState);     //c注释状态执行操作 /*

void DO_CPP_State(FILE *PRead, FILE *PWrite, State *PState);   //c++状态执行操作  //

#endif // !__CommentConvert_H__

CommentConvert.c
#include"CommentConvert.h"



void CommentConvert(FILE *PRead, FILE *PWrite)
{
    //状态机  多个状态
    //   无状态  c注释状态   c++状态   eof状态
    State state = NUL_State;
    while (state != END_State)         //当文件未读完时
    {
        switch (state)
        {
            case NUL_State:
                DO_NUL_State(PRead, PWrite, &state);
                break;
            case C_State:
                DO_C_State(PRead, PWrite, &state);
                break;
            case CPP_State:
                DO_CPP_State(PRead, PWrite, &state);
                break;  
        }
    }   
}


void DO_NUL_State(FILE *PRead, FILE *PWrite, State *PState)
{
    int first = fgetc(PRead);
    switch (first)
    {
        case '/':                  //注释的开始
        {
            int second = fgetc(PRead);
            switch (second)
            {
                //      // /* 
                case'*':                          //c注释开始
                {
                    fputc('/', PWrite);
                    fputc('/', PWrite);
                    *PState = C_State;
                }
                    break;
                case'/':                        //c++注释开始
                {
                    fputc(first, PWrite);
                    fputc(second, PWrite);
                    *PState = CPP_State;
                }
                    break;
                default:                      //正常读到代码即 2/3 等情况 
                {
                    fputc(first, PWrite);
                    ungetc(second, PRead);
                }
                    break;  
            }
        }
            break;
        case EOF:                  //文件的结束
            *PState = END_State;
            break;
        default:                    //正常代码
        {
            fputc(first, PWrite);
        }
            break;
    }
}


void DO_C_State(FILE *PRead, FILE *PWrite, State *Pstate)       //c注释的处理
{
    int first = fgetc(PRead);
    //        a   */   **/    */i
    switch (first)
    {
        case '*':
        {
            int second = fgetc(PRead);
            switch (second)
            {
                case '/':                          //c注释结束
                {
                    int third = fgetc(PRead);
                    if (third == '\n')
                    {
                        fputc(third, PWrite);
                    }
                    else                        //考虑到连续两个c注释的问题 比如  /* int a = 1; */  /* int b = 1;*/   将它们放在两行
                    {
                        fputc('\n', PWrite);
                        ungetc(third, PRead);
                    }
                    *Pstate = NUL_State;
                }
                    break;
                case '*':                      //   **/  ******/   等问题
                {
                    fputc(first, PWrite);
                    ungetc(second, PRead);
                }
                    break;
                default:                      //正常读到代码
                {
                    fputc(first, PWrite);
                    ungetc(second, PRead);
                }
                    break;
            }
        }
            break;
        case '\n':             //多行注释
        {
            fputc(first, PWrite);
            fputc('/', PWrite);
            fputc('/', PWrite);
        }
            break;
        default:
        {
            fputc(first, PWrite);
        }
            break;
    }
}


void DO_CPP_State(FILE *PRead, FILE *PWrite, State *PState)
{
    int first = fgetc(PRead);
    switch (first)
    {
        case '\n':                       //c++注释结束
        {
            fputc(first, PWrite);
            *PState = NUL_State;
        }
            break; 
        case EOF:                 //文件尾
            *PState = END_State;
            break;
        default:                         //正常读到代码
            fputc(first, PWrite);
            break;

    }
}
test.c
#include"CommentConvert.h"


void test()
{
    FILE *PRead = fopen("input.c", "r");
    if (PRead == NULL)
    {
        perror("error for PRead ");
        exit(EXIT_FAILURE);
    }
    FILE *PWrite = fopen("output.c", "w");  
    if (PRead == NULL)
    {
        perror("error for PWrite ");
        exit(EXIT_FAILURE);
    }
    CommentConvert(PRead, PWrite);
    fclose(PRead);
    PRead = NULL;
    fclose(PWrite);
    PWrite = NULL;
}

int main()
{
    test();
    return 0;
}

测试代码 input.c


2/3           //代码中只出现一个/的情况
/*这是一段代码
  这段代码只用作测试
  注释为添加的各种情况
*/int Fib(int n)         
{
    int ret = 0;   /*//ret为返回值//*/int i = 0;
    int count0 = 1;  /***count0为第n-2个fib的值***/
    int count1 = 0;  /***count0为:***/ /*第n-2个fib的值***/
    for (i = 0; i < n; i++)   //  /*从第一个开始计算*/
    {
        //从第一个
        //开始
        /*计算ret的值。*/ret = count0 + count1;
        count0 = count1;    /*让count0跟着i变化/**/
        count1 = ret;
    }
    return ret;       //返回求得的第n个fib的值   /**/
}

测试结果:

这里写图片描述

我们也可以将前面的流更改为标准的输入输出流,这样我们就可以在cmd窗口里输入并显示输出了,不过它的显示是输入一行输出一行,所以看起来可能不是很容易,不过原理与前面代码相同。

以上即为实现注释转换的全部内容,不足之处还望指正。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值