我正在寻找一个放置几GB文档的地方(主要是.doc和.xls).我的团队已经设置了Subversion服务器来管理我们创建的文档,所以如果可能的话,我更愿意使用它.Subversion如何处理所有这些额外的东西？其中大部分是遗留信息,并且只有一个版本,但可能会更新一些文档.
我已经被警告过,SVN并不是特别容易使用的二进制文件.我很谨慎尝试它是否有效,因为它们总是在存储库历史记录中,即使我后来删除它们也是如此.
任何替代品？我们需要能够评论和/或标记文档,但我们可以使用类似于美味的服务与SVN(或类似)中的文档的URL相结合.
后来 我不太担心二进制文件的差异,因为如上所述,它们不会有太大变化.如果他们这样做的话我会有轻微的麻烦 - 这并不比SharePoint差.
我搜索过Google和JetBrains网站,但是我找不到com.intellij包的文档.
有任何想法吗 (:-))？
我正在使用一个私有构造函数而不是枚举的类(这是一个要求).现在我正在尝试添加javadoc标记来记录每个public static final实体.
1)放置javadoc标签的首选位置:喜欢ob1还是ob2？
2)两个选项都会在IDEA中产生错误
@value tag must reference field with a constant intializer.
/**
* {@value #ob1} object1 description
*/
public class MyClass {
public static final Object ob1 = new Object();
/**
* {@value #ob2} object2 description
*/
public static final Object ob2 = new Object();
private MyClass() {}
}
NDoc有一个XML元素inheritdoc,它允许您从父类(或实现的接口)继承成员的文档.但是,Visual Studio(即C#编译器)不理解此标记并抱怨文档不存在或完整.StyleCop和其他一些工具也是如此.有替代方法吗？你如何保持文档完整,但没有重复XML描述？
基本要求是:
我们正在考虑使用某种wiki引擎,但它需要使用文件进行存储,或者有其他方式"部署"给客户并且易于安装/维护.此外,它必须是免费/廉价(汇合太昂贵)
有什么建议？
编辑:我不是在寻找用于记录代码的工具,我们已经使用Sandcastle进行了覆盖.
哪些是可以在类中使用的特殊双下划线/ dunder方法的完整列表？(例如,__init__,__new__,__len__,__add__)
我刚刚发布了这个问题并了解了<see cref="">,但是当我尝试的时候
/// This is a set of extensions that allow more operations on a <see cref="byte[]"/>.
编译器给了我关于它没有正确格式化的警告.我需要做什么才能正确看到代码引用？
在许多django项目中,在docs目录中我可以看到*.rst文件:
浏览它们的最佳方式是什么(当然不使用文本编辑器)？
这有可能生成HTML吗？
有没有办法如何在sphinx文档中自动显示变量var1和var2及其init-values？
class MyClass:
"""
Description for class
"""
def __init__(self, par1, par2):
self.var1 = par1 * 2
self.var2 = par2 * 2
def method(self):
pass
我使用PyCharm IDE来协助制作符合PEP0257标准的文档字符串.它提供了两个属性,我不完全理解它们之间的区别/用法:
:raise Exception: exception explanation here:raises Exception: exception explanation here我什么时候会在我的文档中使用raise反对raises？具体来说,如果一个类需要一个未提供的参数并引发一个TypeError,那应该用来记录它？