我想知道是否可以在类的文档(文档字符串)中创建“节”。假设我有一个大型的非平凡类,其中包含多个实例属性和几种方法。在C ++中,我们可以通过Doxygen轻松地完成此任务。
class MyLargeclass {
public:
/** \name Group A of attributes */
//@{
/// Atribute a1
unsigned a1;
/// Atribute a2
unsigned a2;
//...
//...
//@}
/** \name Group B of attributes */
//@{
/// Atribute Alpha for this.
unsigned alpha;
/// Atribute Beta for that.
unsigned beta;
//...
//...
//@}
public:
/** \name Methods for magic */
//@{
/// Pirimpimpim
void shazam();
/// Burn then down!
bool castFire();
//@}
/** \name Methods for learning */
//@{
/// Old fashion way.
void readABook();
/// New trend.
void watchYouTubeVideo();
//@}
};
使用香草Doxygen(无特殊配置或自定义配置),我们得到以下格式:
请注意,我们已按类型对属性和方法进行了分类。属性a1
和a2
属于功能“组A”,属性alpha
和beta
属于“组B”。最重要的是,这些方法是根据其功能进行分类的。
我们如何在标准Python文档中实现这一目标?换句话说,假设我们正在reStructuredText ou Google documentation format中编写标准文档字符串,而我们正在使用Sphinx(以及'napoleon'和/或'autodoc'),我们可以这样做吗?还有其他一些python文档系统可以实现吗?
我不想为我的软件包编写单独的文档,因为在这种方法中,文档和代码经常不同步。我想使文档尽可能接近代码,就像我们在C ++中一样。
我也不想在多个功能类或模块中分解代码,否则,我只需要创建一个数据对象/结构并传递给函数,就像在C或Julia中一样。
谢谢!
卡洛斯