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

老板,别再让打工人写文档和注释了

  •  
  •   leontung ·
    ZhenhangTung · 2022-01-12 22:12:02 +08:00 · 4191 次点击
    这是一个创建于 805 天前的主题,其中的信息可能已经有所发展或是发生改变。

    害,我真是忍不住了,要 Code Review 我能理解(已经在求助大家有没有提效的方案了),但还要求写注释和文档,说是为了方便知识共享和新人入职。 WTF ?也不看看我们的业绩压力,万一不巧被裁下个月就去喝西北风了,新人关我 P 事。

    索性吐槽一下看看大家想法:

    1. 我经历过小中大厂,经历的大部分代码是没有注释的,某些写得像屎山的代码,看起来十分费劲,重构不好还要挨刀子背锅,被骂出 bug
    2. 我花力气看懂了,好心写了注释,好像也没人关心?老板也不怎么来 code review ,都是同事之间+1 和 LGTM ,感觉我吃力不讨好
    3. 我发现其他人写的 bug ,我都是飞书告诉他要修掉或者我自己默默修掉了,如果我再和老板说 xxx 的代码有问题,感觉有点像背后捅一刀?给老板感觉也不好,为了鸡毛蒜皮的事情邀功?
    4. 之前在一家外企用那破 Confluence 让我抓狂,现在公司用飞书文档体验好了,但维护起来麻烦啊,代码更新了 Readme 和文档也要更新

    年底了,就问问大家,大家写文档和注释有年终奖不?(逃…

    正经时间:

    其实我打心底觉得写文档和注释是个好习惯,毕竟咱们是靠代码吃饭的,但在公司内部有业绩压力有时候是心有余力不足,况且好多时候工具和代码是割裂的。 因此我正在写一个 VSCode 的插件,做一款基于代码的协作和知识分享,而不是现在基于文档( README 、飞书等)。 就目前而言,我希望先实现:

    1. 在代码仓库里写注释的时候,如果看到有价值的信息,可以在 IDE 里同步到飞书文档 /Github 的 Readme 里等(这块还在想)
    2. IDE 里顺手创建一个 Github/Gitlab issue ,再分配给我的同事(这个已经在做)
    3. 同步消息到飞书群 /钉钉群大家都能看到,显得我中立一点不要像是个打小报和为了这件事打报告的人 老板,咱们有锅背锅,有功拿奖行不行。

    不知道大家是否感兴趣?如果感兴趣的话留个联系方式,等我开发完之后发给大家做 beta 测试。也可以给我提点意见。

    真是难为我这个写 Golang 的后端,每天下班后啃前端代码(不说了,去写了...

    附带效果: 选择代码块 在插件上写个标题就能创建一个 Github Issue

    8 条回复    2022-01-18 16:34:53 +08:00
    enchilada2020
        1
    enchilada2020  
       2022-01-12 22:19:34 +08:00 via Android   ❤️ 1
    有点意思 差点进来直接开骂 翻到后面原来是推广个人闭源项目 行吧 友军厚葬 /狗头
    leontung
        2
    leontung  
    OP
       2022-01-12 22:22:41 +08:00
    @enchilada2020 感谢送我到黄浦江边:) 如果要上 VS Code 市场的话,开源是首选,特别是还涉及代码这样敏感的插件,必须把代码整整齐齐地暴露给大家 review
    solemelo
        3
    solemelo  
       2022-01-12 22:23:16 +08:00
    纯吐槽贴?
    vigossliao
        4
    vigossliao  
       2022-01-13 10:42:05 +08:00
    codestream 怎么说
    XTTX
        5
    XTTX  
       2022-01-13 14:23:58 +08:00
    Copilot 可以通过你的注释给你推荐代码, 我觉得出个给代码出注释能赚大大大钱
    zachlhb
        6
    zachlhb  
       2022-01-13 17:18:19 +08:00 via iPhone
    写代码注释文档是程序员的基本素养
    marsyu6211
        7
    marsyu6211  
       2022-01-14 18:09:38 +08:00
    厚葬吧
    V2Axiu
        8
    V2Axiu  
       2022-01-18 16:34:53 +08:00
    写,省的 bb
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   我们的愿景   ·   实用小工具   ·   3230 人在线   最高记录 6543   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 26ms · UTC 11:41 · PVG 19:41 · LAX 04:41 · JFK 07:41
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.