c# - 编码标准维基

Question

在我的工作地点，我负责创建编码标准文档。通常，我们在一定程度上遵循 FxCop 和 StyleCop 工具报告的内容，但我们真正需要的是解释何时使用约定、为什么甚至是简单示例的文档。

将来也可以将其扩展到其他目的。

我想到的第一件事是拥有一个内部 wiki 站点，我们可以随着时间的推移轻松构建和更改，但我以前从未使用过基于 wiki 的引擎，并且想要一些建议。

如果可能的话，引擎应该在 C# 中，以便我们能够根据需要对其进行调整。

如果您认为 wiki 解决方案是解决此问题的错误方法，请提供替代方案:)

更新

我刚刚被告知，虽然我们确实有一个 php 服务器，但它不会留下来，所以恐怕基于 php 的 wiki 想法已经不在讨论范围内了。

更新 2

您能否（如果可能）让我知道这些解决方案是否适用于 Active Directory？

干杯托尼

score 4 · Accepted Answer

ScrewTurn Wiki是一个用 C# 和 ASP.Net 制作的免费开源 wiki。可以使用不同的数据库后端，例如 MSSQL 和 MySQL，但也可以在没有任何数据库的情况下工作。它有几个插件可以与 Active Directory 一起使用。

score 2 · Accepted Answer

Mindtouch Deki

很棒的 wiki，它建立在 C# 和 PHP 之上，因此您可以在 Mono 或 .NET 上使用它。它还具有 Active Directory 集成。

下载他们现成的 VMware 映像。它开始在我自己的 PC 上使用它，然后在他们准备好后将它移到公司的 VMware 服务器上。

score 1 · Accepted Answer

我们在我的商店保留了一个内部 wiki，其中包含我们几乎所有的文档（不仅仅是编码标准）。我们并没有真正看到需要推出自己的产品，所以我们只使用了MediaWiki ...

score 1 · Accepted Answer

我们使用 JAMWiki 并喜欢它。

这是一个可靠的应用程序，我们只与应用程序和开发人员进行了良好的交互。

你维护代码的人在回答问题和帮助用户方面做得很好。

score 1 · Accepted Answer

Brad Abrams 发布了一组在线 C# 编码标准：

如果您访问 Microsoft ASP.NET 站点的入门工具包部分，您会发现有几个 wiki 可供下载，例如 ScrewTurn 和 Flexwiki。一个 wiki 将非常适合您的需求 :-)

score 0 · Accepted Answer

我第二个 MediaWiki。它不是 C#，但它可以成为通过后门偷偷进入一些免费软件的好借口。

但是，如果你们是 Microsoft 商店，并且正在使用 Sharepoint，那么它具有一些内置的 wiki 式功能。

score 0 · Accepted Answer

在我开发的一个项目中，我设置了一个 MediaWiki wiki 用于开发文档，一个用于在线帮助。

我什至直接从源代码和数据库生成部分开发文档。

score 0 · Accepted Answer

在我所在的商店，他们使用了一个非常好的商业包：Confluence。特别好的是它与 LDAP/AD 集成，因此您不需要单独的登录，而且它的构建特别考虑了商业用途，并且有很多免费插件。我们不能没有它。

score 0 · Accepted Answer

当您说您没有 php 服务器时，我对您的意思感到困惑。它在人类已知的每个平台上运行。我注意到大多数 Visual Studio 开发人员不知道 PHP 在 IIS 上运行。

我会选择 mediawiki 它拥有最大的功能集和为其开发的大多数附加组件，以防您需要将数据移植到其他地方。如果你需要修改你的维基，那你就做错了。