编码规范维基百科

8
在我的工作场所,我被指定负责创建一个编码标准文档。通常情况下,我们会在一定程度上遵循 FxCop 和 StyleCop 工具的报告,但我们真正需要的是一个能够解释何时使用惯例、为什么使用以及甚至提供简单示例的文档。
这可能在未来扩展到其他用途。
我脑海中首先想到的是建立一个内部维基站点,我们可以随着时间的推移进行构建和更改,但我从未使用过基于维基的引擎,并且希望得到一些推荐。
如果可能,引擎应该是 C# 的,这样我们就能够根据需要进行调整。
如果您认为维基解决方案不适合此问题,请提供替代方案 :)
更新:
我刚刚得知,虽然我们有一个 PHP 服务器,但它将不再保留,所以恐怕基于 PHP 的维基想法已经不可行了。
更新2:
如果可能,您能否让我知道这些解决方案是否与 Active Directory 兼容?
谢谢 Tony
9个回答

4

ScrewTurn Wiki是一个用C#和ASP.Net制作的免费开源维基百科。可以使用不同的数据库后端,如MSSQL和MySQL,也可以不使用任何数据库。它有几个插件与Active Directory一起使用。


非常好的推荐。我之前用过这个工具来记录开发人员的功能,也用于内部工具文档编写。对于你所寻找的内容,它将是一个很棒的工具。 - Rick Glos
我已经尝试过它并且非常印象深刻,使用AD工作相对快速地启动了它,还有语法高亮和Sql支持。太棒了 :) - TWith2Sugars

2

Mindtouch Deki

这是一个非常棒的Wiki,它使用C#和PHP构建,因此可以在Mono或.NET上使用。同时还支持Active Directory集成。

您可以下载他们准备好的VMware镜像。我自己首先在个人电脑上试用,然后当公司准备好时将其移动到公司的VMware服务器上。


1

我们在公司保留了一个内部维基,其中几乎包含了我们所有的文档(不仅仅是编码标准)。我们并没有真正看到需要自己开发一个维基,所以我们使用了 MediaWiki……


谢谢推荐 - 我会试一试。 - TWith2Sugars

1

我们使用JAMWiki并且非常喜欢它。

JAMWiki是一个可靠的应用程序,我们与应用程序以及开发人员的互动一直非常顺畅。

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


1

Brad Abrams已经发布了一套在线的C#编码标准:

http://blogs.msdn.com/brada/articles/361363.aspx

如果您前往 Microsoft ASP.NET 网站的入门套件部分,您将会找到几个可供下载的维基,例如 ScrewTurn 和 Flexwiki。从声音上来看,维基可能是您需要的理想选择 :-)

感谢提供这份文档,是一个很好的起点! - TWith2Sugars

0

我赞同使用MediaWiki。虽然它不是C#,但可以成为一个不错的借口,通过后门引入一些免费软件。

如果你们是微软公司的用户,并且正在使用Sharepoint,那么它具有一些内置的维基功能。


0
在我开发的一个项目中,我为开发文档设置了一个MediaWiki维基和一个在线帮助的维基。
我甚至可以从源代码和数据库中生成部分开发文档。

0
在我所在的商店,他们使用一个非常好的商业软件包:Confluence。特别好的是它与LDAP/AD集成,这样你就不需要单独登录,并且它专为商业用途而构建,还有很多免费插件。没有它,我们无法生存。

如果OP只是想找一个协作编码标准文档的地方,那么Confluence可能过于复杂了。但是,如果公司计划使用wiki进行更广泛的协作,那么我强烈推荐使用Confluence。我们公司正在使用它,而且我们非常满意。 - Tim
目前来说有点过头了,但如果将来我们决定扩展维基,那么我们会重新考虑这个问题。 - TWith2Sugars

0

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

我会选择mediawiki,它具有最大的功能集和最多的附加组件开发,以防您需要将数据移植到其他地方。如果您需要修改您的wiki,则做法是错误的。


我必须承认,我也不知道PHP可以在IIS上运行。 - TWith2Sugars

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接