标签: documentation

我在哪里可以找到C#3的深度指南?

看来C#3在我没有注意的情况下打击了我,你能告诉我关于C#3的深度指南吗?从lambda到linq,再到第三版语言引入的其他内容.

印刷书籍会很好,但在线指南会更好!

c# documentation c#-3.0

16
推荐指数
2
解决办法
784
查看次数

Python中的"接口":Yea还是Nay?

因此,我在静态土地上花了大量时间后开始使用Python.我已经看到一些项目使得"接口"实际上只是没有任何实现的类.之前,我嘲笑这个想法,忽略那些项目的那一部分.但现在,我开始热衷于这个想法了.

我们很清楚,Python中的界面看起来像这样:

class ISomething(object):
    def some_method():
        pass
    def some_other_method(some_argument):
        pass
Run Code Online (Sandbox Code Playgroud)

请注意,您没有将self传递给任何方法,因此要求重写该方法以进行调用.我认为这是一种很好的文档和完整性测试形式.

那么每个人对这个想法的看法是什么?我做过的所有C#编程都被洗脑了,还是这个好主意?

python documentation coding-style interface

16
推荐指数
6
解决办法
3230
查看次数

开发人员文档:Sharepoint文档管理与ScrewTurn Wiki

背景资料

我正在为我公司的开发人员设置一种方法来共享有关我们各种内部系统的文档和信息.这可能包括有助于提高新员工速度的信息,以及用户对系统及其解决方案的常见问题的描述.

对我来说这似乎是一个理想的维基工作,由于我们公司只能托管ASP.NET应用程序,所以我开始研究可用的ASP.NET wiki.ScrewTurn Wiki似乎是最合适的,它功能非常齐全,有几个可用的插件对我的情况很有用,包括语法高亮和AD集成.

然而,在启动将ScrewTurn部署到我们的Intranet的过程时,突然想起,嘿,Sharepoint 2007有一个wiki,而且由于我们已经设置了Sharepoint,我们不能只使用它吗?我对Sharepoint"wiki"进行了一些评估(在引号中,因为它几乎没有资格),并且能够证明它由于它的许多缺陷而不适合,我将不在此列出.

现在,在这一点上,有人建议我可能根本不需要维基,我们不能只在Word文档中执行所有操作并使用Sharepoint的文档管理功能吗?

实际的问题

所以我正在寻找的是一些额外的弹药,最好是有经验的人.在内部开发人员文档的上下文中,Sharepoint难以或不可能的事例是什么?什么是wiki更好?嘿,我心胸开阔,Sharepoint更好的是什么?

什么使得部署维基而不是简单地使用我们已经拥有的东西值得?

documentation sharepoint moss wiki

16
推荐指数
3
解决办法
6760
查看次数

Java文档覆盖方法不是InheritDoc

覆盖另一个方法的方法不会继承它覆盖的方法的文档.有没有办法明确告诉它继承文档?

/**
  * {@inheritDoc}
  * 
  * This implementation uses a dynamic programming approach.
  */
@Override
public int[] a(int b) {
    return null;
}
Run Code Online (Sandbox Code Playgroud)

java eclipse documentation inheritdoc

16
推荐指数
2
解决办法
2万
查看次数

Google Voice API文档

我花了最后一小时搜索官方Google Voice API文档,但除了一堆API包装器之外找不到任何东西(insert your favorite programming language here).

是否存在Google Voice API的文档?

documentation google-voice

16
推荐指数
2
解决办法
3万
查看次数

你知道好的JMonkeyEngine教程和文档吗?

我对JMonkey感兴趣的一些有趣的项目,但当我搜索谷歌找到教程和文档时,我只能找到真正的基本和/或不完整的东西,比如这些在http://jmonkeyengine.org/上,或者真的具体那些.你知道JMonkey的一些"从初学者到专家"的教程吗?

java documentation jmonkeyengine

16
推荐指数
2
解决办法
1万
查看次数

使用autodoc时,Sphinx找不到Python包

我正在尝试为实际项目创建测试Python项目的文档.我的系统:Win7 64位,python 2.7.5 64位.

我的项目名称是testDoc.它包括名为t的 python pakage,它包含2个模块t1t2__init__.py.

__init__.py 包含:

import t1
import t2
Run Code Online (Sandbox Code Playgroud)

t1.py包含:

'''
Created on 27  2013

@author: 
'''

class MyClass(object):
    '''
    Hi
    '''


    def __init__(self,selfparams):
        '''
        Constructor
        '''
        pass
Run Code Online (Sandbox Code Playgroud)

要创建文档,我在testDoc的命令行中运行:

sphinx-apidoc -A "me" -F -o docs .
Run Code Online (Sandbox Code Playgroud)

Sphinx根据Sphinx文档创建了许多文件.然后,conf.py被修改

sys.path.insert(0, os.path.abspath(absolute path to testDoc))
Run Code Online (Sandbox Code Playgroud)

我输入docs文件夹并输入

make html
Run Code Online (Sandbox Code Playgroud)

并获得以下错误输出:

Making output directory...
Running Sphinx v1.1.3
loading pickled environment... not yet created
building …
Run Code Online (Sandbox Code Playgroud)

python documentation python-sphinx

16
推荐指数
1
解决办法
1万
查看次数

哪里可以在线找到python-Levenshtein的文档?

我在http://code.google.com/p/pylevenshtein/找到了一个实现Levenshtein函数(距离,比率等)的伟大python库,但该项目似乎无效,文档无处可寻.我想知道是否有人比我更了解并且能指出我的文档.

python documentation levenshtein-distance

16
推荐指数
2
解决办法
2万
查看次数

如何正确阅读Apple iOS文档?

我正在按照我在网上找到的教程,有这样的代码行:

var myImage = UIImage(named: "icon")
Run Code Online (Sandbox Code Playgroud)

我明白这行是做什么的,但我当然不想记住它,我想了解作者如何提出这段代码,所以我在文档中搜索UIImage类引用,在初始化器部分下面没有任何内容识别这段代码,为什么呢?我在哪里可以找到有关此代码的更多信息

我在网上看了很多教程,看了很多视频教程,看了很多书,所有这些都没有例外,他们给你看了代码,他们完全解释了,但他们没有告诉你他们是如何想出来的,他们是如何为正确的工作找到合适的方法的?

我应该花时间阅读Apple文档而不是所有这些教程吗?有什么我做错了吗?我错过了什么吗?我不想记住我读过的所有内容,这不是我想学习开发应用程序的原因,我想知道在哪里寻找合适的代码,我想学习像开发人员一样思考.

documentation ios swift

16
推荐指数
2
解决办法
3908
查看次数

Sphinx和可重复使用的Django应用程序

问题

在尝试为可重用的Django应用程序生成sphinx文档时,我发现了以下snafoo.当sphinx解析model.py代码时,它会被试图访问Django 项目设置的代码所阻挠.由于这是一个独立/可重用的应用程序,因此没有提供这些设置的主项目,即没有ROOT/PROJECT/PROJECT/settings.py文件.

建立

为了清楚起见,这就是我所做的.遍历通常的项目文件夹cd ROOT/PROJECT并创建一个生成以下结构的应用程序 django-admin startapp APPLICATION

/ROOT/
  /PROJECT/
    /APPLICATION/ 
      admin.py
      apps.py
      models.py
      tests.py
      views.py
Run Code Online (Sandbox Code Playgroud)

注意:没有/ROOT/PROJECT/PROJECT/*.py文件,因为我没有导航到文件夹cd root并使用通常可能的方式创建项目django-admin createproject.

接下来创建sphinx文档,spinx-quickstart docs生成以下附加结构.

/ROOT/
  /PROJECT/
    /docs/
      /source/ 
        ...
        conf.py
      make.bat
Run Code Online (Sandbox Code Playgroud)

那就是文档旁边的文档APPLICATION.

如果没有文件,我可以放置什么conf.py来正确加载应用程序settings.py

家庭作业

在尝试解决这个问题时,我已经仔细阅读了许多SO问题,博客和Django文档,但没有找到简洁的解决方案.因为这已经被问了几次之前我想要激励它不会被重复关闭,如果建议的副本中的答案使用其中一个片段作为解决方案.

python django documentation python-sphinx

16
推荐指数
1
解决办法
773
查看次数