首页
学习
活动
专区
圈层
工具
发布

谈谈编码与规范

注释应该采用 JSDoc 风格还是 Markdown 风格? 私有属性约定用下划线开头吗? 函数最好不要超过多少行?...道理不用多说,对他人的风格我们要懂得尊重,无论是在现实生活中,还是在写代码时。 当然,认可的规范还是得遵守。比如别在公共场合裸奔,别在一个 UTF-8 团队把文件存成 GBK 编码。...对待风格,要懂得尊重。 #关键 一旦你拥有了开放的心态,一旦你开始懂得去欣赏他人的风格,你会发现世界是五彩缤纷的,你会开始越过一些表象,关注起一些真正值得关注的。...不再去纠结四空格还是两空格后,你会看到 代码的逻辑抽象是否正确? 代码背后的数据模型是否可以优化? 这段代码是否应该放在这个文件里? 这个模块的职责是否过大? 这个设计模式是否用得太僵硬?...#最后 代码如人,风格的差异很正常,彼此尊重。相爱是灵魂的碰触,别停留在表象。

52810
  • 您找到你想要的搜索结果了吗?
    是的
    没有找到

    代码评审做个人?

    在评审一份代码时,有些事项长期处在我的关注榜头部,比如设计是否考虑到了边界情况、代码是否有合理的单测覆盖。也有一些事项,因看似无关痛痒一直未引起足够重视,直到最近,我才渐渐发现它们的重要性。...因此,当你在参与评审时,请谨记这一点:保持谦逊、尊重他人,无论对方的经验或背景如何。优秀的表达,能做到内容即使在批评,也能让对方感受到自己仍是被尊重的。 让我来举一个例子。...除了保持谦逊和尊重,还有一些其他值得采用的评审沟通小技巧: 一例胜千言:有时用文字洋洋洒洒写一大堆,不如直接写几行代码,举一个实际的代码样例。...见什么人说什么话:对于加入团队一个月和一年的开发者,你在评审时可以(也应该)区别对待;对缺乏经验的新人,组织语言时要谨慎,尽量避免让对方感觉不被尊重,产生太多的挫败感;对熟稔的老人,语言风格就可以相对随意...在评审中,永远保持谦逊、尊重他人,无论对方的经验或背景如何。 对于有着不同经验的待评审者,应当采取不同的沟通风格。 代码评审是一项涉及多人协作的复杂事务,里面藏着许许多多的学问。

    48120

    开源生态的繁荣密码:让每一份贡献都被看见、被尊重

    —— 代码注释里的疑问石沉大海,PR 页面安静得像从未存在过。...、提交测试用例,提升项目稳定性; 社区维护者:在 Issue 区解答疑问、整理需求反馈,搭建开发者沟通桥梁; 设计贡献者:优化项目官网 UI、设计 Logo,提升项目的视觉体验; 翻译贡献者:将文档、注释翻译成多语言...就像 Linux 内核社区,每年都会发布详细的贡献者名单,小到修复一行注释的开发者,都能在名单中找到自己的名字。...被尊重:构建开源共同体的核心纽带 如果说 “被看见” 是激活热情的钥匙,那 “被尊重” 就是留住贡献者的纽带 —— 尤其在国产开源社区,“尊重” 还承载着 “传承技术理念、培养本土人才” 的责任。...如何让每一份贡献都被看见、被尊重?

    18510

    没想到吧?Grammarly 竟然有开源(白嫖)替代品,而且更好用!

    Scramble 不仅功能强大,还尊重用户的隐私。它并不会像一些大公司一样,把你输入的文字上传到云端进行处理。对于那些注重隐私的用户来说,Scramble 无疑是个更好的选择。...图为开发者一起参与共建,添加了支持本地 llm举个例子,如果你是一名程序员,需要检查代码中的注释或者文档是否合规,Scramble 就能帮你设置一些特定规则来进行检查。...比如,你写了一段话,系统会告诉你是否存在重复用词,或者一些句子是否冗长。这些小细节可能不会像语法错误那样明显,但一旦改进,能让整篇文章的质量瞬间提升。...它不仅免费、开源,还尊重用户隐私,功能强大且灵活。无论你是日常写作,还是需要处理学术论文、技术文档,甚至是代码注释,Scramble 都能轻松应对。...所以,如果你还在犹豫是否要为 Grammarly 付费,不妨试试 Scramble。你会发现,原来写作助手也可以这么简单、这么自由。

    1.1K10

    利用Ruby的Typhoeus编写爬虫程序

    首先,我应该检查用户是否已经安装了Typhoeus。通常,Ruby库需要通过gem安装,所以在代码示例前可能需要提醒用户安装gem。然后,我需要考虑用户可能的场景:是单次请求还是多个并行请求?...是否需要处理异步响应?用户可能没有明确说明目标网站,所以示例需要通用,比如爬取某个示例网站。...同时,需要注意遵守robots.txt和网站的使用条款,避免法律问题,所以在示例中加入相关的注释提醒是必要的。接下来,结构部分。...以下是一个使用 Ruby 的 Typhoeus 库编写的爬虫程序示例,包含基础功能和注释说明:require 'typhoeus'require 'nokogiri' # 用于解析HTML​# 安装必要...response.return_message}" nil endend​# 使用示例if __FILE__ == $0 # 注意:请遵守目标网站的 robots.txt 和服务条款 # 请勿高频请求,尊重网站服务器负载

    40010

    自定义 Discuz 样式

    span class="pipe"> |{lang index_members}: $_G['cache']['userstats']['totalmembers']”,并注释掉...为了尊重版本,discuz在标题(title)上,一般会加上“- Powered by Discuz!”,如下图: ? 但是出于美观的考虑,需要把它删除,步骤如下: 打开 ....\template\default\mobile\common\footer.htm,注释掉红线标记部分,如下图: ?...上图看上去,很不美观,且管理员、超级版主等属于论坛隐私信息,一般不对外显示,因此需要隐藏,步骤如下: 管理中心——》界面——》页面设置——》论坛首页——》缩略显示在线列表:——》勾选”是“(默认是否),...X1.5/X2升级到v2.1.6(V2接口)教程 郑重声明: 本文仅供学习交流,示例论坛请见 forum.ithomer.net 为了保护软件著作权,修改后也请尊重作者(公司)的版权信息,谢谢。

    2.6K21

    技术文章

    偏见评估指标为了评估语言模型根据这些提示生成的句子中的偏见,测量了五个属性:情感:句子的各个单词是否表明对主题的积极或消极倾向。毒性:所使用的语言是否不尊重、辱骂、令人不快或有害。...尊重:整个句子是否表明积极或消极的倾向,而不管单个词的价态。心理语言规范:词语选择所传达的情感,如喜悦、愤怒或悲伤。性别极性:特定类别的提示是否产生更偏向男性或女性的句子。...技术方法测量情感和尊重时,使用了现成的分类器。测量毒性时,使用了在公共毒性评论数据集上进行微调的BERT语言模型。...一种方法是,首先使用嵌入来(捕获词语部分语义内容的向量表示)确定特定词语是否更通常与男性或女性相关联。然后使用加权平均将单个词语的性别极性聚合成句子级别的分数。...在另一种方法中,只是选取文本中性别极性最强的词,如果它超过了根据带注释文本经验确定的阈值,则将整个文本指定为该性别极性。

    9310

    全新LikeGirl情侣小站 v5.2.0终极浪漫体验来袭!

    或者以任何方式出售以前有在卖的也就算了我也不再去计较 希望之后别让我再看到~写这个的初衷就是为了学习 我也没想过要收费什么的 欢迎小白进群交流如果有人脸皮这么厚 拿开源的项目去卖钱 那你真是活不起了 我可以理解开发不易也需要许多精力和时间 请尊重作者版权前端页面版权信息可以进行删除...(前端底部)...其他区域的版权信息请保留 如注释或js版权 请勿删除 给予开源的尊重目前写入了Pjax无限加载 页面体验会更加高效 音乐不会打断播放 一切正常使用 调试了两天基本遇到的问题都已经解决后端使用了...Ajax异步请求提交数据 配合插件提醒弹窗最后强调 项目完全免费 尊重作者版权 请带有版权意识 感谢~LikeGirl5.2.0更新说明新增留言祝福页面点击直达底部留言按钮更换前端所有导航卡片图标修复留言祝福无法获取...调整页面样式使用说明文章书写需了解HTML标签基本语法可以百度查询资料学习部署后会有一篇默认文章 可以参考书写格式食用方法打开根目录下的admin文件夹接着找到Config_DB.php文件 打开后按注释提示更改为你的数据库相关信息请认真填写安全码

    42010

    驳《编码规范是技术上的遮羞布》自由发挥==摆脱编码规范?X

    写注释有错吗? 三、有心者才能伤心,没心没肺你伤的着吗?   ”编码规范真正的罪恶在于,它们在伤你的心,伤整个团队的心。它们是一种耳语在说你不够优秀。他们不信任你。没有监管,你会搞的一团糟”。...程序员需要尊重,情感上,工作上都需要。但是,我就看不出,统一排版布局怎么就伤者程序员的心了。是注释伤了你的心吧?...那些不写注释,却自称大牛的家伙,是没伤到自己的心,可是看他代码的程序员确是伤了心的,什么鬼东西啊,狗屎一滩。...但是个人认为,程序员能否创造价值,能否带来好处,不在于他是否摆脱了编程规范的束缚,而在于他在所从事的领域有没有建设性的创新,而这种创新也不是代码规范不规范而能评价的了的。

    44520

    执行个编码规范真的就那么难吗?

    写注释有错吗? 三、有心者才能伤心,没心没肺你伤的着吗?   ”编码规范真正的罪恶在于,它们在伤你的心,伤整个团队的心。它们是一种耳语在说你不够优秀。他们不信任你。没有监管,你会搞的一团糟”。...程序员需要尊重,情感上,工作上都需要。但是,我就看不出,统一排版布局怎么就伤者程序员的心了。是注释伤了你的心吧?...那些不写注释,却自称大牛的家伙,是没伤到自己的心,可是看他代码的程序员确是伤了心的,什么鬼东西啊,狗屎一滩。...但是个人认为,程序员能否创造价值,能否带来好处,不在于他是否摆脱了编程规范的束缚,而在于他在所从事的领域有没有建设性的创新,而这种创新也不是代码规范不规范而能评价的了的。

    75630

    14个提高代码质量的好问题

    现在的很多公司已经不尊重科学和客观规律了,如果让他来管理孕妇,我觉得他们恨不得要把 10 个月的产期缩短成 2 个月。...是否遵循经典的设计原则和设计思想(SOLID、DRY、KISS、YAGNI、LOD 等)? 设计模式是否应用得当?是否有过度设计? 代码是否容易扩展?如果要添加新功能,是否容易实现?...代码是否可以复用?是否可以复用已有的项目代码或类库?是否有重复造轮子? 代码是否容易测试?单元测试是否全面覆盖了各种正常和异常的情况? 代码是否易读?...是否符合编码规范(比如命名和注释是否恰当、代码风格是否一致等)? 以上是一些通用的关注点,可以作为常规检查项,套用在任何代码的重构上。...是否方便 debug 排查问题? 接口是否易用?是否支持幂等、事务等? 代码是否存在并发问题?是否线程安全? 性能是否有优化空间,比如,SQL、算法是否可以优化? 是否有安全漏洞?

    55620

    不是程序员,代码也不能太丑!python官方书写规范:任何人都该了解的 pep8

    这些规范,实质是尊重程序的逻辑 1/4 缩进与空格:体现逻辑 Indentation 缩进 著名美剧《硅谷》里有个情节, 程序员会因为使用制表符还是空格吵得不可开交,似乎是一个原则性问题?...而且,我读过很多优秀的开源框架,其也没有尊重这个标准。 原因很简单,我们的生产环境不同。 我喜欢大字体,而且我只有一个小小的笔记本电脑,连工位都没有。...2/3 注释文件标准?我复议 pep 8 与 pep 257 中,都对注释方式进行了标准化,如下。...原因: •我记得 pyCharm 中,默认的注释并不是这样的,说明标准并不是唯一的•具体使用什么标准,我觉得要 就事论事 ,比如 MkDocs 会帮我们自动地把注释编译成文档并发布在网上,因此我们想要使用...如上是 thu-ml/tianshou 源码,其注释使用 markdown 写的, 如果去访问说明文档,你会发现说明文档就是根据源代码注释自动生成的。 ? Amazing.

    75130
    领券