代码、日志、文档、注释

最新推荐文章于 2023-08-04 10:00:55 发布
最新推荐文章于 2023-08-04 10:00:55 发布
阅读量148 收藏
点赞数
分类专栏： 后端
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/fallingcarter/article/details/103634134
版权

代码、日志、文档、注释、空格各占五分之一。
产品出产品文档，开发出技术文档。
注释里面应该包含一点点产品文档的东西。
有时候产品文档转注释需要转换一下。

fallingcarter
关注
专栏目录
代码注释生成文档工具
12-05
代码注释生成文档工具，带有demo，对于文档的生成维护很有帮助
java代码注释规范文档
09-18
后端开发技术的代码注释规范 单行注释 多行注释 块注释 文档注释 标签注释等等
C# 代码注释文档
czjnoe的博客
09-08 355
XML标记 描述 <c> 将文本设置为类似代码的字体 <code> 将一行或多行源代码或程序输出设置为某种字体 <example> 表示所含的是示例 <exception> 标识方法可能引发的异常 <include> 包括来自外部文件的XML <list> 创建列表或表 <para> 用于将结构添加到文本中 <param> 描.
注释生成Api文档
weixin_33923148的博客
09-23 309
1.开发背景 最近一直在写dubbo接口，以前总是用word文档写接口描述然后发给别人。现在太多了，而且跟别人对接联调的人家急着用，根本没时间去写word文档。那就想想怎么用doc文档注释自动生成接口文档了。本来以前对这一块有点印象，但是并不熟悉，加上没有很强烈的要去使用的意图，所以一直没有弄。今天要感谢公司的大神，大家都叫他欧神，神一样的男人。让我用文档注释。然后就知道怎么弄了，以下是生成的流...
强大的Doxygen工具使用手册
热门推荐
永远即等待的专栏
06-20 2万+
张三：假如我们自己开发了一个类库，怎么做一个方便阅读的文档呢？ 李四：一个方法一个方法地写呗，就像写Excel文档一下。 张三：啊，你out了，这多慢呀。为什么不玩玩doxygen工具，它能帮你生成文档？ 李四：这么爽，什么东东，给说讲讲。 1. Doxygen, what？ Doxgen就是大名鼎鼎的文档生成工具，而且是免费开源的，它使用非常方便，能提取C++，Java，Obj
C++代码文档生成器 根据代码及注释自动生成代码文档.zip
01-30
C++代码文档生成器是一种工具，它能够自动分析C++源代码，并基于代码中的注释生成详细的文档。这种工具在软件开发过程中非常有用，因为它可以帮助开发者快速了解代码结构，节省了手动编写文档的时间，同时也确保了...
tsdoc：TypeScript的文档注释标准
02-04
文档链接 -项目概述和路线图 -其他开发人员的实时帮助 -了解语法元素，如@param ， @remarks等。 解析器引擎的交互式演示 -如何在此仓库中构建和调试项目 提出拉取请求的说明 此monorepo中的项目 夹 版 变更日志 ...
自主研发的软著申请代码文档整理输出工具
03-20
可在软著申请时使用的代码文档整理输出工具，可选择多个特定目录，设置多类型文件，指定选择生成代码文档，可操作性很好，并且在生成word代码文档时，过滤了所有空白行和注释，过滤的注释类型涵盖mysql、java、php、...
ParseJavaFile:从目录中的源代码中提取注释。 然后
06-02
这个项目对于维护代码质量、提取文档信息、进行代码审查、了解代码库的历史变化，甚至进行代码自动生成等场景都具有潜在的应用价值。它可以作为开发工具，帮助开发者更好地理解和管理大量的Java源代码。 为了实现这...
基于Spark的实时日志分析及异常检测系统+源代码+文档说明
最新发布
12-28
2、代码特点：内含运行结果，不会运行可私信，参数化编程、参数可方便更改、代码编程思路清晰、注释明细，都经过测试运行成功，功能ok的情况下才上传的。 3、适用对象：计算机，电子信息工程、数学等专业的大学生...
HM代码解释文档
03-30
HM代码对应的文档， 为JCTVC-J1003_d7，对HM软件中各个类的结构、各个函数的实现作了详尽的解释，注，全英文
HM（16.9）的reference software manual（参考软件手册）
03-05
HM最新版本16.9的reference software manual（参考软件手册），这个手册的主要内容包括HM的下载地址和使用方法，更重要的是，里面包含了对配置文件各个参数的详细解释，可以说是使用HM的必备手册。需要的小伙伴不要错过！
文档注释/代码规范
qq_22147803的博客
01-16 252
注释内容可以被JDK提供的工具javadoc所解析，生成一套以网页文件形式体现的该程序的说明文档，一般写在类 基本格式 如何生成对应的文档注释 应用实例 javadoc -d 文件夹名 -xx -yy Demo3.java javadoc标签 ================================================ Java代码规范: 1.类、方法的注释,要以javadoc的方式来写 2.非java Doc的注释,往往是给代码的维护者看的 , 着重告诉读者为什么这样写
Dart 代码注释和文档编写规范
Flutter 跨平台技术研究
04-25 909
好的文档是代码编写成功的关键要素 —— 虽然在快速开发的当今，我们不爱写文档。但是实际上代码文档能够帮我们理顺思路，定义好输入输出参数，同时也能够帮助我们日后回顾代码，为团队其他人或是代码接手人提供第一手参考资料。
如何写一个日志注解
炸酱面的博客
01-31 890
1、注解 首先写一个注解 @Target({ElementType.METHOD, ElementType.TYPE}) @Retention(RetentionPolicy.RUNTIME) @Documented public @interface AuditLog { /** * 操作信息 */ String operation(); } 2、写一个日志实体类 该类用来记录日志信息 @Setter @Getter public class Audit {
学习笔记（五）：自定义日志注解
qq_49111986的博客
05-16 391
自定义注解
自定义日志注解
灼烧的疯狂
03-11 1405
AOP日志的使用、自定义日志注解
自定义日志注解（可获取方法名、参数等）
mail_liuxing的专栏
11-11 3388
自定义注解记录日志，可以获取方法名、参数名、参数值等；
一个注解，优雅搞定操作日志记录（含详细代码及注释）
weixin_59930657的博客
08-04 1116
AOP(Aspect-Oriented Programming)，⾯向切⾯编程，说起AOP，几乎学过Spring框架的人都知道，它是Spring的三大核心思想之一（IOC：控制反转，DI：依赖注入，AOP：面向切面编程）。能够将那些与业务⽆关，却为业务模块所共同调⽤的逻辑或责任（例如事务处理、⽇志管理、权限控制等）封装起来，便于减少系统的重复代码，降低模块间的耦合度，并有利于未来的可拓展性和可维护性。
muduo的官方文档与注释
05-11
muduo是一个基于C++语言的高性能网络库，它的官方文档和注释可以帮助开发者更好地了解和使用该库。 muduo的官方文档主要包括以下几个方面： 1. muduo库的基本概念和架构：介绍了muduo库的核心组件和基本架构，包括网络编程、线程池、定时器、日志等。 2. muduo的使用方法：详细介绍了如何使用muduo库进行网络编程、线程池的使用、定时器的使用、日志的使用等。 3. muduo的API参考：列出了muduo库中各个模块和函数的详细说明，包括函数的参数、返回值、使用方法等。 4. muduo的示例程序：提供了一些muduo库的示例程序，帮助开发者更好地理解和使用该库。 muduo的代码注释也非常详细，主要包括以下几个方面： 1. 文件头部注释：对每个文件进行了详细的注释，包括文件的作用、作者、修改记录等。 2. 类和函数注释：对每个类和函数进行了详细的注释，包括函数的作用、参数、返回值、使用方法等。 3. 变量和宏注释：对每个变量和宏进行了详细的注释，包括变量的作用、类型、取值范围等。 总之，muduo的官方文档和注释非常详细，可以帮助开发者更好地了解和使用该库，提高开发效率和代码质量。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值