タイトル †
事例 †
課題 †
MemoryContextDataはMemoryContextを呼び出しており、MemoryContextはMemoryContextDataを呼び出している。
このため、どちらから読めばいいのかわからない。
※さらに、MemoryContextDataのメンバMemoryContextMethodsからもMemoryContextが呼び出されている。
解決方法 †
MemoryContextは下記のように単純なポインタである。
typedef struct MemoryContextData *MemoryContext;
このため、下記手順にて記載する。
- MemoryContextの概要を「MemoryContextDataへのポインタ(再帰的使用あり)」とする。
- MemoryContext解読は、ここで一旦完了として、日付も入れてしまう。
- MemoryContextDataの実装中のMemoryContext呼出部分については「MemoryContextDataへのポインタ(再帰的使用)」と記載する。
- MemoryContextMethodsの実装中のMemoryContext呼出部分についても、同様に「MemoryContextDataへのポインタ(再帰的使用)」と記載する。
- MemoryContextData読解後、MemoryContextの概要にMemoryContextDataの概要を追記する。
上記方法で概要は一応書けました。
履歴 †
コメント †