如何在Javadoc中创建多个级别的缩进?

时间:2011-06-25 15:43:02

标签: documentation javadoc indentation nested-lists

假设,作为记录代码(Javadoc)的一部分,您希望使用深度缩进来指示元素之间的关系。

如何创建嵌套列表:

  • 一些元素
    • 其他一些元素
      • 还有一些其他元素

3 个答案:

答案 0 :(得分:104)

<ul>
  <li>Element</li>
  <ul>
     <li>Subelement...</li>

您可以在javadoc评论中自由使用HTML。

更新:因为它出现了,我试过

<ul>
    <li>one</li>
    <ul>
        <li>one point one</li>
    </ul>   
</ul>

并获取

        
  • 一个
  •     
              
    • 一分一
    •     

我同意适当的嵌套更好。

答案 1 :(得分:7)

正确的方法如下:

public static IEnumerable<string> GetFullPropertyName(Type baseType, string propertyName)
{
    var prop = baseType.GetProperty(propertyName);
    if(prop != null)
    {
        return new[] { prop.Name };
    }
    else if(baseType.IsClass && baseType != typeof(string)) // Do not go into primitives (condition could be refined, this excludes all structs and strings)
    {
        return baseType
            .GetProperties()
            .SelectMany(p => GetFullPropertyName(p.PropertyType, propertyName), (p, v) => p.Name + "." + v);
    }
    return Enumerable.Empty<string>();
}

虽然JavaDoc借用HTML,但它不是HTML,你应该省略/** * <ul> * <li>some element * <li><ul> * <li>some other element * <li><ul> * <li>yet some other element * </ul> * </ul> * </ul> */ 标签,就像你应该省略</li>标签一样。

答案 2 :(得分:6)

嵌套列表应在其自己的<li>内。 <ul>不是<ul>的有效子元素。

所以你的例子是:

<ul>
  <li>some element</li>
  <li>
    <ul>
      <li>some other element</li>
      <li>
        <ul>
          <li>yet some other element</li>
        </ul>
      </li>
    </ul>
  </li>
</ul>