软件文档的CodeChat系统
项目描述
CodeChat 将源代码转换为网页，允许开发者通过添加标题、格式、超链接、图表、图像和其他形式的丰富内容，将程序作为一篇美丽且描述性的文档来查看，以捕捉编写程序过程中自然涌现的想法和洞察。它还提供了一个空白画布，用于提前规划，通过在将算法提交到代码之前绘制算法草图或规划设计文档，该文档可以随着代码的演进而发展。这种文档化编程范式通过将思想与实现代码相结合，改变开发者思考方式，显著提高程序员的技能。
背景
简单来说，文学编程（LP）是一种认识，即程序是一份写给程序员并供程序员阅读的文档，而不仅仅是计算机指令列表。因此，LP工具会生成格式良好的文档，其中包含与说明性文字交织的代码。唐纳德·克努斯（Donald Knuth）在其开创性的论文中，使用他的WEB工具引入了文学编程，论文链接为http://www.literateprogramming.com/knuthweb.pdf。根据该论文中的图1，WEB系统以.w文档为输入，然后生成用于编译的“纠缠”源文件，或者生成作为.tex文件的“编织”文档。文档非常美观；WEB源文件难以理解（见图2a-c）；源代码完全无法阅读（见图3）。尽管多年来有许多工具试图解决这些问题，但只有一种受LP启发的变体得到了广泛认可：文档生成器，如Doxygen和JavaDoc，它们直接从源代码中提取文档，而不是像WEB和大多数LP工具那样从文档中提取源代码。CodeChat通过直接从代码生成文档；使用人类可读的标记（reStructuredText）；以及通过支持GUI来加快和简化LP文档-程序的编辑来克服LP的这些弱点。
入门指南
有关更多信息，请参阅CodeChat文档。
下载文件
下载适合您平台的文件。如果您不确定选择哪一个，请了解有关安装包的更多信息。
源代码分发
构建分发
CodeChat-1.9.4.tar.gz的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | f627588d27032728c86396d227a847a9d1cc0fd8da723345bb7510c72726fa61 |
|
| MD5 | 3a1c99ec805270a03b83396b55112abd |
|
| BLAKE2b-256 | 67714f422117f793620b426e7ddfc39762eda067763cee43b565470775a34d76 |
CodeChat-1.9.4-py3-none-any.whl的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 5251e1ca343bfb94c5526f1c503cdebbf35dc2d6990a9dd9054cffce72e4b3de |
|
| MD5 | 705681de7d70e79f4dd97abebd6cefeb |
|
| BLAKE2b-256 | 8180ad4ed308106b1d15b347154ed0b2e2b2766d238796d99aa73e20c0751354 |