V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
爱意满满的作品展示区。
metrue
V2EX  ›  分享创造

撸了一个注释 typo 检测工具

  •  
  •   metrue ·
    metrue · 2015-02-15 15:38:54 +08:00 · 2357 次点击
    这是一个创建于 3570 天前的主题,其中的信息可能已经有所发展或是发生改变。

    之前请v友们推荐一个代码中注释typo 检查的工具,v友们一致推荐 Jetbean,
    有没有好的代码注释 typo 检查工具推荐么

    但是本人vim党,所以尝试撸了一个命令行工具简单的对已有代码库进行检查,虽然检测的准确行还有待提高,不过大致自己心里有个底了。
    感兴趣的同学可以看看。
    Github https://github.com/metrue/typocheck

    当然也可以直接通过RubyGems安装。

    $ gem install typocheck

    6 条回复    2015-02-18 15:06:27 +08:00
    zeroday
        1
    zeroday  
       2015-02-16 20:14:41 +08:00
    试用了一下,执行

    typocheck --type python --file 0070/main.py

    测试这个文件

    https://gist.github.com/arcticlion/ac73d58f52167fb4576d

    没看明白返回的结果是什么含义

    https://gist.github.com/arcticlion/8ad23126fce8effb114f
    metrue
        2
    metrue  
    OP
       2015-02-16 23:28:06 +08:00
    @zeroday
    返回的结果是原文件和修改之后的文件的diff
    zeroday
        3
    zeroday  
       2015-02-17 13:27:47 +08:00
    @metrue 看到了,并且会生成.corrected文件

    似乎不是很正确,代码中内建函数的函数名也被修改了。
    metrue
        4
    metrue  
    OP
       2015-02-17 18:25:34 +08:00
    @zeroday

    谢谢你的测试,如果你不显麻烦的话,你git pull 一下,然后运行
    ./typocheck.rb -f test.rb

    你会更清楚的看到你写词语可能需要修改,有颜色的标注的。Mac 和 Linux 应该都可以。
    zeroday
        5
    zeroday  
       2015-02-17 20:59:55 +08:00
    @metrue 版本是 0.9 吗?刚才又测试了一下,似乎还是和原来一样。

    我输入的命令是
    typocheck --type python --file 0070/main.py

    看结果我觉得似乎程序对python注释部分没有识别好,把代码部分也进行了识别和修改。python注释是以
    '#'和'"""'开头的。
    metrue
        6
    metrue  
    OP
       2015-02-18 15:06:27 +08:00
    @zeroday

    现在版本应该应该是2.0了,我把 """ 写成了'''了,刚刚做了更新。
    不过其实gem的方式不如我在github上面的typocheck.rb的diff效果好,因为 typocheck.rb 调用了一个带颜色而且双栏显示的diff工具(python写的),而我push到gem的版本只是使用系统的diff,所以效果不是很好看。
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   1034 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 22ms · UTC 23:06 · PVG 07:06 · LAX 15:06 · JFK 18:06
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.