首页
学习
活动
专区
圈层
工具
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往
  • 您找到你想要的搜索结果了吗?
    是的
    没有找到

    JSDoc 初探:代码内的文档标记

    JSDoc 3 是一个用于 JavaScript 的API文档生成器,类似于 Javadoc 或 phpDocumentor。可以将文档注释直接添加到源代码中。...JSDoc 工具将扫描你的源代码并为您生成一个 HTML 文档网站(当然,即使你不进行生成,其也被大部分浏览器所识别和支持)。JSDoc 的目的是记录 JavaScript 应用程序或库的 API。...type) 进行判断,避免出现未定义的错误。使用=标记具有默认值的参数or可选参数在JSDoc中,可以使用 = 符号来标记具有默认值的参数。...需要注意的是,在JSDoc中标记参数具有默认值并不会改变函数或方法的实际调用方式,你可以只在注释中写好标记的默认参数,而不写在代码中,反之亦然(君子协定)。...对象内的参数,你可以使用嵌套的@property标签。

    28810

    使用Zero Clipboard实现JS网页代码复制到剪贴板功能,所有浏览器全兼容

    前几天,好友让我帮忙增加一个复制二维码链接的功能,虽然说这个功能在很多网站都能看到,但是你会经常看到“此功能不支持该浏览器,请手工复制文本框中内容”,这是因为大都用“window.clipboardData...很爽快的答应了朋友,网上也搜索了一大堆,大都同样的思路,个别针对浏览器增加几个判断,但都不能兼容所有浏览器。...最终从WordPress顺藤摸瓜,找到了jQuery ZeroClipboard(简称jquery-zclip),顺而找到了无需依赖jQuery的ZeroClipboard。顺利解决了问题。...相关代码 </...请访问Github jQuery Zero Clipboard Github地址:https://github.com/patricklodder/jquery-zclip Zero Clipboard的官方地址

    1.9K20

    遵循SOLID原则:构建高内聚低耦合的代码

    遵循这些原则可以帮助开发者设计出高内聚、低耦合的代码,从而提高代码的可读性、可维护性和可扩展性。本文通过具体的代码示例详细阐述了这五个原则的含义及其在实际项目中的应用。...这意味着我们应该允许在不修改现有代码的前提下,增加新的功能。 例如,我们有一个Shape类,AreaCalculator类计算一组形状的面积。...里氏替换原则(Liskov Substitution Principle, LSP) 子类型必须能够替换它们的基类型。这意味着如果一个类的子类不能替换它的父类,那么可能会导致代码的混乱。...我们应该将Machine接口拆分为Printer、Fax和Scanner接口。...总结 遵循SOLID原则可以帮助我们设计出高内聚、低耦合的代码: 高内聚:通过单一职责原则和接口隔离原则,我们可以保证每个类或模块只做一件事情,且做好一件事情,从而提高内聚性。

    15210

    IntelliJ IDEA 中JAVA代码的任务标记(TODO、FIXME、【自定义】)

    【任务标记是以注释的方式定义】 一、作用: 1、可以大大的提高开发效率。代码量非常大的项目,在某一行中需要在后续阶段实现一个功能,如果不标注下次再找的时候就非常困难了。...2、在团队合作中,还可以告诉别人某处敏感代码的状态。...二、以下为常见的两种注释标记: 1、// TODO: 表示在此处将要实现的功能,提醒你在后续阶段将会在此处添加代码 2、// FIXME: 表示此处的代码逻辑有出入,或者根本不能运行,提醒你在后续阶段将会修改此处代码...3、// 在Eclipse中可以自定义标记 例如: // XXX:表示此处的代码虽然实现了功能,但是性能太低,提醒你需要在后续阶段优化; // DONE:已经完成 添加自定义标记的步骤:...三、如何快速找到项目中的标记处: 点击即可快速跳转到标记处代码

    5.6K11

    容器内的潘多拉——恶意代码

    从最基本的层面来讲,容器让你可以将更多的计算工作负载塞入到单单一台服务器上,并且让你可以在一瞬间为新的计算任务提高增加容量。...恶意代码是一种程序,它通过把代码在不被察觉的情况下镶嵌到另一段程序中,从而达到破坏被感染电脑数据和运行具有入侵性或破坏性的程序等目的。...按传播方式,恶意代码可以分成五类:病毒,木马,蠕虫,移动代码和复合型病毒. 如今恶意代码类型数量和种类众多,为我们造成很多严重的危害,怎么才能减少这些危害呢?...那就是用户拥有并可以执行恶意代码,而且他们可以试着从容器内部侵入系统。 在本次大会上, Ben 将分享过去三年里构建 Katacoda 的经验教训以及一些有趣的故事和安全性袭击。...大致内容如下: 1、Docker 和 Kubernetes 非常好的安全性 2、Docker 和 Linux 安全问题 3、监视恶意活动 4、当一切都出错时,会发生什么 最后,与会者将学到可行性强的保护系统的不同方法

    1K10

    如何避免写出高耦合低内聚的前端代码?

    这个组件和应用整体的情况基本一样,虽然做了很多封装(大部分 重复/公用 的组件都做了封装),但总让人感觉代码非常分散,无法聚合(改一个地方可能涉及多处代码, 引用组件需要修改组件的内部逻辑等)。...本文尝试从该项目来描述前端开发中一些可能比较严重的问题,思考为什么出现这样的问题,自己如何避免这样的问题: 1、高耦合、低内聚; 2、多数据源; 3、其他问题; 高耦合 我在调用一个组件时,里面有三十几个子组件...低内聚 里面有一个页面,页面中有tab的例子,当切换tab的时候需要做一堆事情: const activeName = ref('firstTab') // 查询列表 getList().then((...,事实上这里的代码量比我描述要恐怖很多。...可以根据依赖倒置的设计,而是通过抽象来调用具体实现,可以将弹窗功能聚合在一起。

    12310

    如何将代码写的更加优雅?

    (开玩笑哈~) 为什么要写这篇文章呢,其实并不是教大家去怎么写好代码,因为我自知目前没有此番阅历和高度,只是觉得自己从上学、实习到工作敲代码的日子和代码量也有了一定的时间和经验了,因此做一篇关于写出优雅代码的总结...下面我们开始正文吧: 1 何为优雅的代码? 在写出优雅的代码之前,我们需要有一个优雅的标准,那么怎么样的代码才能叫优雅呢?...(1)具有良好的可读性,代码让人容易看得懂 (2)更好的可维护性 (3)可拓展性和灵活性,要容易添加新功能,容易复用老接口 (4)简洁性:代码是否简单清晰 (5)可复用性:相同的代码不要写两遍 (6)能够合理处理异常和返回异常信息...2 如何写出更优雅的代码 写出更优雅的代码当然有很多的办法可用,办法虽好,但是我们要尽量避免过度设计,就是将原本简单的代码复杂化,为了优化而优化,要懂得取舍。...当然只学习和了解方法不等于能够写好代码,更多的是要从实践中不断的打磨自己,将优秀的方法不断与自己的风格进行融合,打造出适合自己的方法论和编码习惯才是最好的。

    40320

    如何批量去除代码内的所有注释?Remove.exe批量去除代码注释

    写注释是一个非常好的习惯,但是某些情况下,我们又不想保留代码里的注释,于是就有了下面这个小软件(大小仅1.6m)。...点击此处下载:https://nicen.cn/collect/remove.exe Remove.exe 一个批量去除代码内所有注释的小工具,支持去除C家族系列的单行和多行注释,比如下面这种: /*...多行注释 */ // 单行注释 1.使用说明 双击运行exe文件,将会弹出如下的窗口界面: 启动 点击选择代码目录,选择需要去除注释的项目目录,之后会弹出第二个窗口,如下: 参数 选择需要排除的文件或目录...,然后输入需要移除注释的文件的格式类型,点击运行: 移除注释 耐心等待处理结束。...提醒 移除注释之前,记得备份一份带注释的源文件,代码无价,慎重操作

    1K20

    代码注释中的常见标记

    FIXME 在代码注释中,FIXME 是一个常见的标记,用来指出代码中的一个问题需要被修复或需进一步的工作。...代码可能是临时的解决方案,需要被更完善或更合适的实现所替代。 开发者想要在稍后回顾这部分代码,进行重构或改进。 FIXME 标记通常会伴随一段描述,解释需要修复或关注的具体问题。...FIXME 类似于其他代码注释标记,如 TODO (表示还有工作要做)或 NOTE(用来强调或解释代码的某个方面),但 FIXME 更具有紧迫性,通常表示代码中存在更严重的问题或错误。...OPTIMIZE OPTIMIZE 表示代码在性能方面可以优化,通常用来标记可能的性能瓶颈。...开发团队可能会有自己的注释标记约定,实际使用的标记取决于团队的偏好和工作流程。使用这些标记可以帮助团队成员快速定位代码中需要特别注意的部分。

    12610

    将项目复制到新电脑之后, 无法通过git 进行拉取代码查看历史提交记录等操作

    项目场景: 将项目代码整体打包到新环境(新电脑), 在idea/pycharm下载好git相关插件并打开项目之后, 通过git拉取代码失败(gitlab/git/gtee) ---- 问题描述 最近因工作原因需要讲电脑上的代码迁移到新电脑上..., 但是将idea以及git插件等配置好之后, 打开项目, 发现无法查看之前的提交记录, 即使点击刷新也无法查看....并且更新代码之后, 右下角会提示更新失败 之前曾使用一个最无脑的方法: 就是找到该项目的分支地址, 然后通过git clone 重新拉取代码, 虽然能够成功, 但是在项目代码多了之后就会非常麻烦, 没有真正的去解决问题...因此, 利用git命令为该分支代码全局增加一个安全的本地仓库目录git config --global --add safe.directory 代码仓库地址 ---- 解决方案: 执行git命令, 添加当前目录为新的本地仓库..., 注意选择将传入的更改合并到当前分支.

    70740

    将一个文件内容复制到另一个文件(C语言和C++代码)

    fileCopy.c //作用:将一个文件复制到另外一个文件 // 我的程序代码名:fileCopy.c //使用方法:在文件中找以exe结尾的文件(需要代码已经写完并自己生成exe文件)(以我的为例:...fileCopy.exe),并打开,然后输入:fileCopy sourcefile destfile(sourcefile:被复制的文件名 destfile:复制了sourcefile的内容的文件)...argc 的含义是程序的参数数量,包含本身。 argv []的每个指针指向命令行的一个字符串, 所以 argv [0]指向字符串" copyFile . exe "。...*/ //这里fp没有进行.open()的操作,说明是以默认的方式打开(构造函数的方式) if (!...static char str[100];//防止str里的内容被改变 fp.seekg(ios::beg);//将指针定位到文件头 fp >> str; cout << str << endl

    21310

    C:将代码拆分放在多个文件的操作

    为了更好地管理代码,我们通常会根据不同的功能,将代码拆分成多个文件进行管理。...但是,在企业中,通常情况下我们是不会遇到这么简单的程序代码,或许那些项目都要写上万行代码,这时候就需要根据不同的功能,将代码拆分成多个文件进行管理了。...好处三:提高代码的可读性 将一个大的工程按不同功能将代码拆分到多个文件,使得每个文件中代码相对来说较少,因此更容易理解和阅读,并且由于是按代码功能分装,因此它们的功能更加聚焦和明确。...这样的分工就类似于将代码分装在多个文件中。每个团队专注于自己的任务,只了解自己负责的那部分工作的细节,而对其他团队的具体操作细节是不知情的,从而实现了一定程度上的“隐藏”。...结语: 关于将程序分装在多个文件中的介绍就到这里了,后面会出一篇文章关于使用多个文件来完成代码编写的小游戏。

    12910

    将 asyncawait 异步代码转换为安全的不会死锁的同步代码

    将 async/await 异步代码转换为安全的不会死锁的同步代码 发布于 2018-03-16 03:58...更新于 2018-08-19 11:10 在 async/await 异步模型(即 TAP Task-based Asynchronous Pattern)出现以前,有大量的同步代码存在于代码库中...这里就免不了将一部分异步代码修改为同步代码。然而传统的迁移方式存在或多或少的问题。本文将总结这些传统方法的坑,并推出一款异步转同步的新方法,解决传统方法的这些坑。...代码如下: /// /// 通过 PushFrame(进入一个新的消息循环)的方式来同步等待一个必须使用 await 才能等待的异步操作。... /// 此方法适用于将一个 async/await 模式的异步代码转换为同步代码。

    1.7K10

    VBA代码:将Excel保存为文本文件的几段代码

    标签:VBA 下面的代码将输出一个名为“Test.txt”的文本文件,其中包含常量delimiter中指定的任何分隔符(在本示例中为管道符号)。...Print #nFileNum, Mid(sOut, 2) sOut = Empty End With Next myRecord Close #nFileNum End Sub 下面的代码导出的文件每个字段周围都有引号...Print #nFileNum, Mid(sOut, 2) sOut = Empty End With Next myRecord Close #nFileNum End Sub 下面的代码输出的文本文件不会对引号中有逗号或文本中有双引号的单元格进行修改...无论字段中有多少个字符的数据,字段宽度都是恒定的。少于所需字符数的字段必须用空格或其他字符填充。下面的代码将生成一个具有固定字段的文本文件。字段宽度包含在vFieldArray中。...sOut, Len(DELIMITER) + 1) sOut = Empty End With Next myRecord Close #nFileNum End Sub 注:本文的代码整理自

    35910
    领券