CodeProject 文章常见问题解答 - 第一部分:如何为 CodeProject 撰写一篇好文章





5.00/5 (4投票s)
这是我们文章常见问题解答系列的第一篇文章。在这篇文章中,我们重点介绍那些能帮助你在 CodeProject 上撰写一篇好文章的要求和指南。
目录
分享代码的目的
- 为什么要分享我的代码?
与他人分享代码不仅是帮助他人的好方法,也是成为一名更好的程序员的好方法。成千上万的人下载你的代码,你不仅会获得很多积极的反馈,还会获得错误修复、免费测试,而且通常还会获得关于如何使代码更好的建议。它还鼓励其他人分享他们的代码,反过来让你访问更大的免费源代码库。
- 使用条款是什么?
CodeProject 文章
- 一篇文章需要什么?
首先也是最重要的,我们需要一些解释。这不一定是任何花哨的东西,尽管我们不介意它花哨,但如果您考虑回答以下问题,那么您应该会有一个好的开始。
- 代码做什么?
- 我如何将其集成到我现有的代码中?或者我该如何使用它?
- 如果 CodeProject 上已经有类似的帖子,那么这个帖子有什么不同?为什么有人会想使用您的版本?
- 代码是否有某个特别值得关注的方面,或许应该在文章中涵盖?
- 代码是否仅限于任何特定的环境?(Windows 10 或更高版本,ASP.NET 6.0 等)
- CodeProject 上是否已经有关于此主题的文章? 如果是这样,我的文章有什么不同之处。 请在文章中说明这种差异。
我们的想法是让读者清楚地了解您的代码的用途,而不是强迫他们下载项目,构建它,然后到处寻找以了解示例的作用。 这意味着没有解释代码段作用的代码片段文章是不够的。
- 什么使 CodeProject 文章成为一篇好文章?
作为一个基本的概述,CodeProject 文章遵循一定的布局,以便用户可以从中学习到最多的知识。每篇文章都试图回答以下问题:这个解决方案解决了什么问题?这如何帮助别人?代码实际上是如何工作的?代码片段内部发生了什么?这是一位首次作者提交的作品,他做得非常出色,只是为了让您对初学者文章的可能外观有一个基本的了解:Avoiding InvokeRequired[^]
这是我们一位顶级作者提交的作品。
请记住,CodeProject 读者主要寻找对他们的开发问题进行深入、详尽解释的解决方案,或者可以教他们一些东西,使他们的开发更快、更高效或扩展他们的技能的文章。
在上面的文章中,Sacha 的主要目标是演示“使用 HTML5 WebWorkers 和自定义 jQuery 插件来创建一个 Flickr 图片墙。”他把读者当作初学者。他定义了 jQuery,解释了什么是 WebWorkers,然后深入探讨了他为什么要创建一个 jQuery 插件。文章的每个渐进部分都扩展了他的主题,彻底解释了代码,解释了他在范围内的限制,讨论了插件的每个元素是如何工作的,提供了大量的代码示例,最重要的是,在顶部提供了一个源代码下载,以供读者在需要时使用。
每次社区考虑是否批准一篇文章时,他们脑海中都会浮现出这种风格的文章。他们喜欢它,他们想要它,当他们得到它时,他们会极力赞扬作者(而且我们希望作者感到他们的辛勤工作得到了认可)。
有关撰写文章的更多提示,请参阅以下文章:Code Project 文章写作指南[^]