我需要在perl文档中使用utf-8字符.如果我使用:
perldoc MyMod.pm
我看到奇怪的人物.如果我使用:
pod2text MyMod.pm
一切都好.
我使用Ubuntu/Debian.
$ locale
LANG=de_DE.UTF-8
LC_CTYPE="de_DE.UTF-8"
LC_NUMERIC="de_DE.UTF-8"
LC_TIME="de_DE.UTF-8"
LC_COLLATE="de_DE.UTF-8"
LC_MONETARY="de_DE.UTF-8"
LC_MESSAGES="de_DE.UTF-8"
LC_PAPER="de_DE.UTF-8"
LC_NAME="de_DE.UTF-8"
LC_ADDRESS="de_DE.UTF-8"
LC_TELEPHONE="de_DE.UTF-8"
LC_MEASUREMENT="de_DE.UTF-8"
LC_IDENTIFICATION="de_DE.UTF-8"
LC_ALL=de_DE.UTF-8
是否有关于在Pod中使用特殊字符的方法？
这是一个使用德国变音符号"Just a Test:äöüßÄÖ"的小例子:
$ perldoc perl/MyMod.pm
<standard input>:72: warning: can't find character with input code 159
<standard input>:72: warning: can't find character with input code 150
MyMod(3) User Contributed Perl Documentation MyMod(3)
NAME
MyMod.pm - Just a Test: äöüÃÃÃ
perl v5.10.0 2008-10-16 MyMod(3)
通过Visual Studio中的构建步骤,我需要采取哪些步骤来自动构建HTML文档？我已经准备好所有注释并生成了comments.xml文件,并安装了Sandcastle.我只需要知道要在构建后步骤中添加什么以生成文档.
我终于开始学习Java了,我正在寻找一些可以下载和离线阅读的Java文档.像Sun的东西,但拉链或PDF或CHM.
我正在使用Eclipse,因此可以很好地集成Eclipse.它似乎已经有一些我想要的东西(javadoc的东西),但我没有看到如何搜索它,我没有看到语言参考.
我正在为Sphinx编写一些文档,我想打印出一些仅用于HTML文档的文本块,而不是用于LaTeX文档.有些东西告诉我,我应该能够做到这一点,sphinx.ext.ifconfig但我无法弄清楚如何.有谁知道如何做到这一点？
grails doc在我看来,通过跑步创建的文档并不完全令人满意.例如,控制器中的操作在文档中显示为属性,但我希望有一个额外的部分将操作与实际属性(字符串等)分开.
是否有任何工具可以运行类似JavaDoc的注释并为Grails项目生成更好的输出？它应该是Grails-aware(即理解控制器中的闭包实际上是动作)或允许显式标记(例如@section Actions注释使段落出现在名为"Actions"的部分中)
我找不到如何用C编写我的意思是我知道的意见//和/* */,我的意思是我在哪里可以找到好的做法？就像我有一个函数一样,我如何编写@param variable is the value bla bla,就像在Java中完成一样？
这有什么标准吗？或者我可以像在Java中那样做吗？
Xcode能够检查文档注释问题,并在出现问题时报告警告.例如,我使用CocoaPods将Facebook SDK添加到我的项目中.在文件FBError.h中的某个位置,有以下代码:
/*!
@typedef NS_ENUM (NSInteger, FBErrorCategory)
@abstract Indicates the Facebook SDK classification for the error
@discussion
*/
请注意,该@discussion参数为空,Xcode将相应地生成警告:
传递给'@discussion'命令的空段落
但是,Facebook SDK并不是我添加到项目中的唯一库,而且"问题"选项卡中充满了来自我安装的Pod的第三方文件的其他文档相关警告.
我想知道如何抑制这些文件的这种警告.
我正在尝试使用reST风格的文档字符串,即
def foo(bar):
"""a method that takes a bar
:param bar: a Bar instance
:type bar: Bar
是否有标准的文件记录方式yields？我查看了http://sphinx-doc.org/domains.html#info-field-lists,a-la这个问题[ 使用javadoc for Python文档 ],但没有运气.我想象的是,
:yields: transformed bars
:yield type: Baz
谢谢!
我正在使用两个很棒的工具DRF和Django-REST-Swagger,但是我的一些API视图都在令牌认证下.
所以现在我想在我的API的swagger doc页面中添加测试那些令牌身份验证页面的可能性,包括令牌头.我怎么能这样做？
我的类API视图的快照如下所示:
class BookList(APIView):
"""
List all books, or create a new book.
"""
authentication_classes = (TokenAuthentication, )
permission_classes = (IsAuthenticated,)
...
由于扬鞭自动检测到很多东西,我期待看到约令牌身份验证,并问我关于它的Web界面令牌或用户ID,但事实并非如此.因此我通过CURL命令手动测试它...
我正在尝试将外部API的交叉引用添加到我的文档中,但我面临三种不同的行为.
我正在使用sphinx(1.3.1)和Python(2.7.3),我的intersphinx映射配置为:
{
'python': ('https://docs.python.org/2.7', None),
'numpy': ('http://docs.scipy.org/doc/numpy/', None),
'cv2' : ('http://docs.opencv.org/2.4/', None),
'h5py' : ('http://docs.h5py.org/en/latest/', None)
}
我可以毫不费力地编写numpy API的交叉引用,:class:`numpy.ndarray`或者:func:`numpy.array`像我们预期的那样给我一些像numpy.ndarray这样的东西.
但是,使用h5py,我可以生成链接的唯一方法是省略模块名称.例如,:class:`Group`(或:class:`h5py:Group`)给我Group但:class:`h5py.Group`无法生成链接.
最后,我找不到一种方法来编写一个工作交叉引用OpenCV API,这些似乎都没有工作:
:func:`cv2.convertScaleAbs`
:func:`cv2:cv2.convertScaleAbs`
:func:`cv2:convertScaleAbs`
:func:`convertScaleAbs`
如何正确编写对外部API的交叉引用,或配置intersphinx,以便在numpy情况下生成链接？