开发文档

     

Spring中如何为属性配置文件自动产生文档?

32 6K

在本博客中,您将了解 Spring Configuration Property Documenter Maven 插件,它可以为您解决这个问题。几乎每个 Spring(启动)应用程序都会使用配置属性.

VsCode中给注释说明文字强换行的插件:Rewrap

80

Rewrap 命令是:Rewrap Comment / Text,默认绑定到 Alt+Q. 将光标置于注释块中,点击此按钮可将内容重新换行到 指定的换行列。特征 使用多种语言重新包装注释块,并使用每种.

Vscode插件:将代码连接到IDE中的文档

864
将文档连接到代码并接收警报以在代码更改时更新您的文档。安装:https ://marketplace.visualstudio.com/items?itemName=mintlify.connecto.

怕写文档?AI自动生成代码文档的插件

2100 1
适用于 Python、JavaScript、TypeScript、PHP 和 Java 的 AI 文档编写器,vscode插件点击标题,Intellij Idea插件点这里。写文档很烂。让Mintli.

Google、Twitter 和 Spotify 如何建立文档文化 - DEV

956 3K

许多技术问题最终会变成人的问题,缺乏良好的文档也不例外。编写和维护文档是一种需要鼓励和培养的习惯。不幸的事实是,如果没有文档文化,再多的工具也无济于事。今天,我们将看看 3 家高性能工程公司,Goog.

幽默:好的代码本身就是最好的文档 - CodeWisdom

1237 1

好的代码本身就是最好的文档。在您要添加注释文档时,问问自己:“如何改进代码,以便不需要这些注释文档?” 改进代码,然后对其进行记录以使其更加清晰。 - Steve McConnell 众说纷纭:我猜这.

写作是软件工程师重要的超能 - Gergely Orosz

1407 2

Google8号员工和现在的工程高级副总裁UrsHölzle明确说:写作是工程师重要的超能。  工程师经常低估写作的重要性。投资这项技能,以扩大您向其他人传达信息的能力,成为更有影响力的工程师。大多数.

体面编码之代码注释评论

790

避免无意义的注释评论,不添加任何价值。如果通过阅读代码可以清楚地看到某些内容,则评论只会增加噪音。考虑是否可以改进代码,以便不再需要注释。通过改进命名,重构(例如,提取函数)或引入解释变量,通常可以解.

软件开发设计文档

1 2085

近来公司需要写软件开发文档,文档主要是用来指导开发人员作实际开发用的,之前自己是coder,现在写这种文档不知道如何下手,从哪几个几角度,需要画什么图,都不是很清楚,希望各位指教!.

如何看源码?请大家讨论

32 4419

1、类图肯定要生成,但是跨package就麻烦,如何解决。2、先模拟client 运行一个例子,调试进入source,好像会太琐碎,没有大局观。3、文档肯定要看的,但是好像一般没有设计文档。希望大家讨.