PROSAGA码农传奇-Xedge-lua - 文档的元数据

<div class =“post-text”itemprop =“text”>
  
    好吧，我想我应该回答这个问题。虽然我可能能够在2010年7月15日之后进入可释放状态并且我很乐意手头分享副本，但代码尚未准备好进入黄金时段。
  
  
    有两个想法：
  
  <OL>
    <LI>
      
        每个模块都有一个名为的表
         <code>
 __doc
 </code>
        。模块中的每个名称都会获得一个条目
         <code>
 __doc
 </code>
         表。这是一个例子：
      
       <pre>
 <code>
 __doc.rfc2822_to_localtime_or_nil = [[function(date) returns number or nil
Converts RFC2822 date to local time (Unix time).
]]

</code>
 </pre>
      
        第一行是函数的“简短文档”。我希望有一天它可以动态检查，但现在它只是文档。其余的是“长篇文档”。这里有几个：
      
       <pre>
 <code>
 __doc.to_string = [[function(T) returns string
Converts a message to a string in RFC 2822 format.]]

__doc.to_orig_string = [[function(T) returns string
Returns the string originally used to create the message,
which may or may comply with RFC 2822.]]

</code>
 </pre>
      
        还有各种特殊领域，如
         <code>
 __doc.__overview
 </code>
        ，
         <code>
 __doc.T
 </code>
        ， 等等。
      
    </LI>
    <LI>
      
        有一个命令行工具可以抓取
         <code>
 __doc
 </code>
         字段并提供信息。现在这段代码不是很通用，实现起来很乱。但这里有一些示例输出：
      
      
        整个包的概述（请注意未记录的项目列表，这对于保持诚实至关重要）：
      
       <pre>
 <code>
 % osbf3 internals

Documented modules:
  boot         
  cache        -- the OSBF-Lua message cache
  cfg          
  classifier   
  command_line 
  commands     
  core         
  filter       
  lists        
  log          
  mime         
  mlearn       
  msg          -- parse MIME message and manipulate headers
  options      
  output       
  roc          
  sfid         
  util

Undocumented functions:
  core.hash           
  core.utf8tohtml     
  options.env_default

</code>
 </pre>
      
        一个模块的简短概述：
      
       <pre>
 <code>
 : nr@yorkie 5874 ; osbf3 internals -short msg

msg: T = The representation of a message

msg.add_header = function(T, tag, contents)

msg.del_header = function(T, tag, ...)

msg.fingerprint = function(string) returns string

msg.has_sfid = function(msg.T) returns bool

msg.header_indices = function(msg, tag, ...) returns iterator

msg.headers_tagged = function(msg, tag, ...) returns iterator

msg.of_string = function(s, uncertain) returns T or nil

msg.sfid = function(msg.T, [msgspec]) returns string or calls error

msg.synopsis = function(T, w) returns string

msg.to_orig_string = function(T) returns string

msg.to_string = function(T) returns string

</code>
 </pre>
      
        一个功能的文档：
      
       <pre>
 <code>
 % osbf3 internals msg.synopsis

msg.synopsis = function(T, w) returns string
Returns a string of width w (default 60) which is a synopsis of the
message T.  The synopsis is formed from the Subject: line and the
first few words of the body.

</code>
 </pre>
    </LI>
  </醇>
  
    我们的服务器已关闭，但是当我有机会时，如果有人想玩它，我会发布这个代码的链接。
  
</DIV>